Microsoft Azure

Azure Iotcentral

Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

Endpoints 96

  • GETGet the list of API tokens in an application. The token value will never be returned for security reasons./apiTokens?api-version=string
  • GETGet an API token by ID./apiTokens/:tokenId?api-version=string
  • PUTCreate a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests./apiTokens/:tokenId?api-version=string
  • DELETEDelete an API token./apiTokens/:tokenId?api-version=string
  • GETGet the list of device groups in an application./deviceGroups?api-version=string
  • GETGet the device group by ID./deviceGroups/:deviceGroupId?api-version=string
  • PUTCreate or update a device group/deviceGroups/:deviceGroupId?api-version=stringCreate or update a device group.
  • DELETEDelete a device group./deviceGroups/:deviceGroupId?api-version=string
  • PATCHUpdate a device group via patch/deviceGroups/:deviceGroupId?api-version=stringUpdate an existing device group by ID.
  • GETGet the devices of a device group/deviceGroups/:deviceGroupId/devices?api-version=stringGet the list of devices by device group ID.
  • GETGet the list of device templates in an application./deviceTemplates?api-version=string
  • GETGet a device template by ID/deviceTemplates/:deviceTemplateId?api-version=string
  • PUTPublish a new device template. Default views will be automatically generated for new device templates created this way./deviceTemplates/:deviceTemplateId?api-version=string
  • DELETEDelete a device template/deviceTemplates/:deviceTemplateId?api-version=stringDelete an existing device template by device ID.
  • PATCHUpdate the cloud properties and overrides of an existing device template via patch./deviceTemplates/:deviceTemplateId?api-version=string
  • GETGet the list of devices in an application./devices?api-version=string
  • GETGet a device by ID/devices/:deviceId?api-version=stringGet details about an existing device by device ID.
  • PUTCreate or update a device/devices/:deviceId?api-version=stringCreate a new device.
  • DELETEDelete a device/devices/:deviceId?api-version=stringDelete an existing device by device ID.
  • PATCHUpdate a device via patch/devices/:deviceId?api-version=stringUpdate an existing device by ID.
  • GETGet device attestation/devices/:deviceId/attestation?api-version=string
  • PUTCreate an individual device attestation/devices/:deviceId/attestation?api-version=string
  • DELETERemove an individual device attestation/devices/:deviceId/attestation?api-version=string
  • PATCHUpdate an individual device attestation via patch/devices/:deviceId/attestation?api-version=string
  • GETGet device command history/devices/:deviceId/commands/:commandName?api-version=string
  • POSTRun a device command/devices/:deviceId/commands/:commandName?api-version=stringRun a command on a device.
  • GETList the components present in a device/devices/:deviceId/components?api-version=string
  • GETGet component command history/devices/:deviceId/components/:componentName/commands/:commandName?api-version=string
  • POSTRun a component command/devices/:deviceId/components/:componentName/commands/:commandName?api-version=stringRun a command on a component.
  • GETGet device properties for a specific component/devices/:deviceId/components/:componentName/properties?api-version=string
  • PUTReplace device properties for a specific component/devices/:deviceId/components/:componentName/properties?api-version=string
  • PATCHUpdate device properties for a specific component via patch/devices/:deviceId/components/:componentName/properties?api-version=string
  • GETGet component telemetry value/devices/:deviceId/components/:componentName/telemetry/:telemetryName?api-version=stringGet the last telemetry value from a component.
  • GETGet device credentials/devices/:deviceId/credentials?api-version=string
  • GETList the modules present in a device/devices/:deviceId/modules?api-version=string
  • GETGet module command history/devices/:deviceId/modules/:moduleName/commands/:commandName?api-version=string
  • POSTRun a module command/devices/:deviceId/modules/:moduleName/commands/:commandName?api-version=stringRun a command on a module.
  • GETList the components present in a module/devices/:deviceId/modules/:moduleName/components?api-version=string
  • GETGet module component command history/devices/:deviceId/modules/:moduleName/components/:componentName/commands/:commandName?api-version=string
  • POSTRun a module component command/devices/:deviceId/modules/:moduleName/components/:componentName/commands/:commandName?api-version=stringRun a command on a module.
  • GETGet module properties for a specific component/devices/:deviceId/modules/:moduleName/components/:componentName/properties?api-version=string
  • PUTReplace module properties for a specific component/devices/:deviceId/modules/:moduleName/components/:componentName/properties?api-version=string
  • PATCHUpdate module properties for a specific component via patch/devices/:deviceId/modules/:moduleName/components/:componentName/properties?api-version=string
  • GETGet module component telemetry value/devices/:deviceId/modules/:moduleName/components/:componentName/telemetry/:telemetryName?api-version=stringGet the last telemetry value from a module component.
  • GETGet module properties/devices/:deviceId/modules/:moduleName/properties?api-version=stringGet all property values of a module.
  • PUTReplace module properties/devices/:deviceId/modules/:moduleName/properties?api-version=stringReplace all property values of a module.
  • PATCHUpdate module properties via patch/devices/:deviceId/modules/:moduleName/properties?api-version=stringUpdate property values of a module.
  • GETGet module telemetry value/devices/:deviceId/modules/:moduleName/telemetry/:telemetryName?api-version=stringGet the last telemetry value from a module.
  • GETGet device properties/devices/:deviceId/properties?api-version=stringGet all property values of a device by device ID.
  • PUTReplace device properties/devices/:deviceId/properties?api-version=stringReplace all property values of a device by device ID.
  • PATCHUpdate device properties via patch/devices/:deviceId/properties?api-version=stringUpdate property values of a device by device ID.
  • GETGiven the ID for an upstream device, will return the upstream and the downstream relationships associated with that gateway. These downstream relationships are only those associated with the direct downstream level (they don’t work recursively)./devices/:deviceId/relationships?api-version=stringList all relationships based on device ID
  • GETGiven the ID for a device and a relationship ID associated with this device, get the details of the relationship./devices/:deviceId/relationships/:relationshipId?api-version=stringGet device relationship by ID
  • PUTGiven the ID for a device and a relationship ID associated with this device, create a new relationship for between the given device and a second device specified in the body./devices/:deviceId/relationships/:relationshipId?api-version=stringCreate a device relationship
  • DELETEGiven the ID for a device and an associated relationship ID, delete the relationship. The given device ID can be that of the upstream or downstream device./devices/:deviceId/relationships/:relationshipId?api-version=stringDelete a device relationship
  • PATCHPatch a given relationship given the relationship ID and a given device ID./devices/:deviceId/relationships/:relationshipId?api-version=stringUpdate device relationship
  • GETGet device telemetry value/devices/:deviceId/telemetry/:telemetryName?api-version=stringGet the last telemetry value from a device.
  • GETGet the list of enrollment groups in an application/enrollmentGroups?api-version=string
  • GETGet an enrollment group by ID/enrollmentGroups/:enrollmentGroupId?api-version=stringGet details about an enrollment group by ID.
  • PUTCreate an enrollment group/enrollmentGroups/:enrollmentGroupId?api-version=stringCreate an enrollment group.
  • DELETEDelete an enrollment group/enrollmentGroups/:enrollmentGroupId?api-version=stringDelete an enrollment group by ID.
  • PATCHUpdate an enrollment group/enrollmentGroups/:enrollmentGroupId?api-version=stringUpdate an enrollment group.
  • GETGet the primary or secondary x509 certificate of an enrollment group/enrollmentGroups/:enrollmentGroupId/certificates/:entry?api-version=stringGet details about the primary or secondary x509 certificate of an enrollment group, if it exists.
  • PUTSets the primary or secondary x509 certificate of an enrollment group/enrollmentGroups/:enrollmentGroupId/certificates/:entry?api-version=stringSets the primary or secondary x509 certificate of an enrollment group.
  • DELETERemoves the primary or secondary x509 certificate of an enrollment group/enrollmentGroups/:enrollmentGroupId/certificates/:entry?api-version=stringRemoves the primary or secondary x509 certificate of an enrollment group.
  • POSTGenerate a verification code for the primary or secondary x509 certificate of an enrollment group/enrollmentGroups/:enrollmentGroupId/certificates/:entry/generateVerificationCode?api-version=stringGenerate a verification code for the primary or secondary x509 certificate of an enrollment group.
  • POSTVerify the primary or secondary x509 certificate of an enrollment group/enrollmentGroups/:enrollmentGroupId/certificates/:entry/verify?api-version=stringVerify the primary or secondary x509 certificate of an enrollment group by providing a certificate with the signed verification code.
  • GETGet the file upload storage account configuration./fileUploads?api-version=string
  • PUTCreate the file upload storage account configuration./fileUploads?api-version=string
  • DELETEDelete the file upload storage configuration./fileUploads?api-version=string
  • PATCHUpdate the file upload storage account configuration/fileUploads?api-version=string
  • GETGet the list of jobs in an application/jobs?api-version=string
  • GETGet a job by ID/jobs/:jobId?api-version=stringGet details about a running or completed job by job ID.
  • PUTExecute a new job/jobs/:jobId?api-version=stringCreate and execute a new job via its job definition.
  • GETGet device statuses/jobs/:jobId/devices?api-version=stringGet the list of individual device statuses by job ID.
  • PUTRerun a job on failed devices/jobs/:jobId/rerun/:rerunId?api-version=stringExecute a rerun of an existing job on all failed devices.
  • POSTResume a stopped job/jobs/:jobId/resume?api-version=stringResume execution of an existing stopped job.
  • POSTStop a running job/jobs/:jobId/stop?api-version=stringStop execution of a job that is currently running.
  • GETGet the list of organizations the user has access to in an application/organizations?api-version=string
  • GETGet an organization by ID/organizations/:organizationId?api-version=string
  • PUTCreate an organization in the application/organizations/:organizationId?api-version=string
  • DELETEDelete an organization/organizations/:organizationId?api-version=string
  • PATCHUpdate an organization in the application via patch/organizations/:organizationId?api-version=string
  • GETGet the list of roles in an application./roles?api-version=string
  • GETGet a role by ID./roles/:roleId?api-version=string
  • GETGet the list of scheduled job definitions in an application/scheduledJobs?api-version=string
  • GETGet a scheduled job by ID/scheduledJobs/:scheduledJobId?api-version=stringGet details about a scheduled job by ID.
  • PUTCreate or update a scheduled job/scheduledJobs/:scheduledJobId?api-version=stringCreate or update a scheduled job by ID.
  • DELETEDelete a scheduled job/scheduledJobs/:scheduledJobId?api-version=stringDelete an existing scheduled job by ID.
  • PATCHUpdate a scheduled job via patch/scheduledJobs/:scheduledJobId?api-version=stringUpdate an existing scheduled job by ID.
  • GETGet the list of jobs for a scheduled job definition/scheduledJobs/:scheduledJobId/jobs?api-version=string
  • GETGet the list of users in an application/users?api-version=string
  • GETGet a user by ID/users/:userId?api-version=string
  • PUTCreate a user in the application/users/:userId?api-version=string
  • DELETEDelete a user/users/:userId?api-version=string
  • PATCHUpdate a user in the application via patch/users/:userId?api-version=string

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
96 operations on 49 pathsGET 44PUT 18PATCH 14DELETE 12POST 8
Response formats
application/json
Description format
Swagger 2.0, API version 2022-07-31

How to test the Azure Iotcentral in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Iotcentral collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the list of API tokens in an application. The token value will never be returned for security reasons.” (GET /apiTokens?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Iotcentral?

Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale. It is listed under Developer tools and has 96 endpoints.

Who publishes the Azure Iotcentral?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Iotcentral?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Iotcentral have?

96 operations on 49 paths (44 GET, 18 PUT, 14 PATCH, 12 DELETE, 8 POST).

Is forking the Azure Iotcentral free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.