Class API

constructor

• new API(client): IOT.v1.API

• Parameters

  • client: Client

  Returns IOT.v1.API

Static ReadonlyLOCALITIES

createDevice

• createDevice(request): Promise<CreateDeviceResponse>

• Add a device. Attach a device to a given Hub.

  Parameters

  • request: Readonly<CreateDeviceRequest>

    The request CreateDeviceRequest

  Returns Promise<CreateDeviceResponse>

  A Promise of CreateDeviceResponse

createHub

• createHub(request): Promise<Hub>

• Create a hub. Create a new Hub in the targeted region, specifying its configuration including name and product plan.

  Parameters

  • request: Readonly<CreateHubRequest>

    The request CreateHubRequest

  Returns Promise<Hub>

  A Promise of Hub

createNetwork

• createNetwork(request): Promise<CreateNetworkResponse>

• Create a new network. Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.

  Parameters

  • request: Readonly<CreateNetworkRequest>

    The request CreateNetworkRequest

  Returns Promise<CreateNetworkResponse>

  A Promise of CreateNetworkResponse

createRoute

• createRoute(request): Promise<IOT.v1.Route>

• Create a route. Multiple kinds of routes can be created, such as:

  • Database Route Create a route that will record subscribed MQTT messages into your database. You need to manage the database by yourself.
  • REST Route. Create a route that will call a REST API on received subscribed MQTT messages.
  • Amazon S3 Routes. Create a route that will put subscribed MQTT messages into an Object Storage bucket. You need to create the bucket yourself and grant write access. Granting can be done with s3cmd (s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031).

  Parameters

  • request: Readonly<IOT.v1.CreateRouteRequest>

    The request CreateRouteRequest

  Returns Promise<IOT.v1.Route>

  A Promise of Route

deleteDevice

• deleteDevice(request): Promise<void>

• Remove a device. Remove a specific device from the specific Hub it is attached to.

  Parameters

  • request: Readonly<DeleteDeviceRequest>

    The request DeleteDeviceRequest

  Returns Promise<void>

deleteHub

• deleteHub(request): Promise<void>

• Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone.

  Parameters

  • request: Readonly<DeleteHubRequest>

    The request DeleteHubRequest

  Returns Promise<void>

deleteNetwork

• deleteNetwork(request): Promise<void>

• Delete a Network. Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.

  Parameters

  • request: Readonly<DeleteNetworkRequest>

    The request DeleteNetworkRequest

  Returns Promise<void>

deleteRoute

• deleteRoute(request): Promise<void>

• Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.

  Parameters

  • request: Readonly<IOT.v1.DeleteRouteRequest>

    The request DeleteRouteRequest

  Returns Promise<void>

deleteTwinDocument

• deleteTwinDocument(request): Promise<void>

• BETA - Delete a Cloud Twin Document.

  Parameters

  • request: Readonly<DeleteTwinDocumentRequest>

    The request DeleteTwinDocumentRequest

  Returns Promise<void>

deleteTwinDocuments

• deleteTwinDocuments(request): Promise<void>

• BETA - Delete all the documents of a Cloud Twin.

  Parameters

  • request: Readonly<DeleteTwinDocumentsRequest>

    The request DeleteTwinDocumentsRequest

  Returns Promise<void>

disableDevice

• disableDevice(request): Promise<Device>

• Disable a device. Disable an existing device, specified by its device ID.

  Parameters

  • request: Readonly<DisableDeviceRequest>

    The request DisableDeviceRequest

  Returns Promise<Device>

  A Promise of Device

disableHub

• disableHub(request): Promise<Hub>

• Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.

  Parameters

  • request: Readonly<DisableHubRequest>

    The request DisableHubRequest

  Returns Promise<Hub>

  A Promise of Hub

enableDevice

• enableDevice(request): Promise<Device>

• Enable a device. Enable a specific device, specified by its device ID.

  Parameters

  • request: Readonly<EnableDeviceRequest>

    The request EnableDeviceRequest

  Returns Promise<Device>

  A Promise of Device

enableHub

• enableHub(request): Promise<Hub>

• Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.

  Parameters

  • request: Readonly<EnableHubRequest>

    The request EnableHubRequest

  Returns Promise<Hub>

  A Promise of Hub

getDevice

• getDevice(request): Promise<Device>

• Get a device. Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object.

  Parameters

  • request: Readonly<GetDeviceRequest>

    The request GetDeviceRequest

  Returns Promise<Device>

  A Promise of Device

getDeviceCertificate

• getDeviceCertificate(request): Promise<GetDeviceCertificateResponse>

• Get a device's certificate. Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate.

  Parameters

  • request: Readonly<GetDeviceCertificateRequest>

    The request GetDeviceCertificateRequest

  Returns Promise<GetDeviceCertificateResponse>

  A Promise of GetDeviceCertificateResponse

getDeviceMetrics

• getDeviceMetrics(request): Promise<GetDeviceMetricsResponse>

• Get a device's metrics. Get the metrics of an existing device, specified by its device ID.

  Parameters

  • request: Readonly<GetDeviceMetricsRequest>

    The request GetDeviceMetricsRequest

  Returns Promise<GetDeviceMetricsResponse>

  A Promise of GetDeviceMetricsResponse

  Deprecated

getHub

• getHub(request): Promise<Hub>

• Get a hub. Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object.

  Parameters

  • request: Readonly<GetHubRequest>

    The request GetHubRequest

  Returns Promise<Hub>

  A Promise of Hub

getHubCA

• getHubCA(request): Promise<GetHubCAResponse>

• Get the certificate authority of a hub. Get information for a particular PEM-encoded certificate, specified by the Hub ID.

  Parameters

  • request: Readonly<GetHubCARequest>

    The request GetHubCARequest

  Returns Promise<GetHubCAResponse>

  A Promise of GetHubCAResponse

getHubMetrics

• getHubMetrics(request): Promise<GetHubMetricsResponse>

• Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID.

  Parameters

  • request: Readonly<GetHubMetricsRequest>

    The request GetHubMetricsRequest

  Returns Promise<GetHubMetricsResponse>

  A Promise of GetHubMetricsResponse

  Deprecated

getNetwork

• getNetwork(request): Promise<Network>

• Retrieve a specific network. Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.

  Parameters

  • request: Readonly<GetNetworkRequest>

    The request GetNetworkRequest

  Returns Promise<Network>

  A Promise of Network

getRoute

• getRoute(request): Promise<IOT.v1.Route>

• Get a route. Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration.

  Parameters

  • request: Readonly<IOT.v1.GetRouteRequest>

    The request GetRouteRequest

  Returns Promise<IOT.v1.Route>

  A Promise of Route

getTwinDocument

• getTwinDocument(request): Promise<TwinDocument>

• BETA - Get a Cloud Twin Document.

  Parameters

  • request: Readonly<GetTwinDocumentRequest>

    The request GetTwinDocumentRequest

  Returns Promise<TwinDocument>

  A Promise of TwinDocument

listDevices

• listDevices(request?): Promise<ListDevicesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Device[], void, void>);
      all: (() => Promise<Device[]>);
  }

• List devices. List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<ListDevicesRequest> = {}

    The request ListDevicesRequest

  Returns Promise<ListDevicesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Device[], void, void>);
      all: (() => Promise<Device[]>);
  }

  A Promise of ListDevicesResponse

listHubs

• listHubs(request?): Promise<ListHubsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Hub[], void, void>);
      all: (() => Promise<Hub[]>);
  }

• List hubs. List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<ListHubsRequest> = {}

    The request ListHubsRequest

  Returns Promise<ListHubsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Hub[], void, void>);
      all: (() => Promise<Hub[]>);
  }

  A Promise of ListHubsResponse

listNetworks

• listNetworks(request?): Promise<ListNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Network[], void, void>);
      all: (() => Promise<Network[]>);
  }

• List the networks.

  Parameters

  • request: Readonly<ListNetworksRequest> = {}

    The request ListNetworksRequest

  Returns Promise<ListNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Network[], void, void>);
      all: (() => Promise<Network[]>);
  }

  A Promise of ListNetworksResponse

listRoutes

• listRoutes(request?): Promise<IOT.v1.ListRoutesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<RouteSummary[], void, void>);
      all: (() => Promise<RouteSummary[]>);
  }

• List routes. List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<IOT.v1.ListRoutesRequest> = {}

    The request ListRoutesRequest

  Returns Promise<IOT.v1.ListRoutesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<RouteSummary[], void, void>);
      all: (() => Promise<RouteSummary[]>);
  }

  A Promise of ListRoutesResponse

listTwinDocuments

• listTwinDocuments(request): Promise<ListTwinDocumentsResponse>

• BETA - List the documents of a Cloud Twin.

  Parameters

  • request: Readonly<ListTwinDocumentsRequest>

    The request ListTwinDocumentsRequest

  Returns Promise<ListTwinDocumentsResponse>

  A Promise of ListTwinDocumentsResponse

patchTwinDocument

• patchTwinDocument(request): Promise<TwinDocument>

• BETA - Patch a Cloud Twin Document.

  Parameters

  • request: Readonly<PatchTwinDocumentRequest>

    The request PatchTwinDocumentRequest

  Returns Promise<TwinDocument>

  A Promise of TwinDocument

putTwinDocument

• putTwinDocument(request): Promise<TwinDocument>

• BETA - Update a Cloud Twin Document.

  Parameters

  • request: Readonly<PutTwinDocumentRequest>

    The request PutTwinDocumentRequest

  Returns Promise<TwinDocument>

  A Promise of TwinDocument

renewDeviceCertificate

• renewDeviceCertificate(request): Promise<RenewDeviceCertificateResponse>

• Renew a device certificate. Renew the certificate of an existing device, specified by its device ID.

  Parameters

  • request: Readonly<RenewDeviceCertificateRequest>

    The request RenewDeviceCertificateRequest

  Returns Promise<RenewDeviceCertificateResponse>

  A Promise of RenewDeviceCertificateResponse

setDeviceCertificate

• setDeviceCertificate(request): Promise<SetDeviceCertificateResponse>

• Set a custom certificate on a device. Switch the existing certificate of a given device with an EM-encoded custom certificate.

  Parameters

  • request: Readonly<SetDeviceCertificateRequest>

    The request SetDeviceCertificateRequest

  Returns Promise<SetDeviceCertificateResponse>

  A Promise of SetDeviceCertificateResponse

setHubCA

• setHubCA(request): Promise<Hub>

• Set the certificate authority of a hub. Set a particular PEM-encoded certificate, specified by the Hub ID.

  Parameters

  • request: Readonly<SetHubCARequest>

    The request SetHubCARequest

  Returns Promise<Hub>

  A Promise of Hub

updateDevice

• updateDevice(request): Promise<Device>

• Update a device. Update the parameters of an existing device, specified by its device ID.

  Parameters

  • request: Readonly<UpdateDeviceRequest>

    The request UpdateDeviceRequest

  Returns Promise<Device>

  A Promise of Device

updateHub

• updateHub(request): Promise<Hub>

• Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID.

  Parameters

  • request: Readonly<UpdateHubRequest>

    The request UpdateHubRequest

  Returns Promise<Hub>

  A Promise of Hub

updateRoute

• updateRoute(request): Promise<IOT.v1.Route>

• Update a route. Update the parameters of an existing route, specified by its route ID.

  Parameters

  • request: Readonly<IOT.v1.UpdateRouteRequest>

    The request UpdateRouteRequest

  Returns Promise<IOT.v1.Route>

  A Promise of Route

waitForHub

• waitForHub(request, options?): Promise<Hub>

• Waits for Hub to be in a final state.

  Parameters

  • request: Readonly<GetHubRequest>

    The request GetHubRequest
  • Optionaloptions: Readonly<WaitForOptions<Hub>>

    The waiting options

  Returns Promise<Hub>

  A Promise of Hub