/

/Azure IoT Central

Changes Docs Sign in

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 24m ago · Updated 2mo ago

Filter operations

getGet the list of API tokens in an application. The token value will never be returned for security reasons.
getGet an API token by ID.
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.
deleteDelete an API token.
getGet the list of dashboards in an application.
getGet a dashboard by ID.
putCreate a dashboard
deleteDelete a dashboard
patchUpdate a dashboard
getGet the list of destinations in an application.
getGet a destination by ID.
putCreate or update a destination
deleteDelete a destination.
patchPatch a destination.
getList all exports connected to the given destination.
getGet the list of exports in an application.
getGet an export by ID.
putCreate or update an export
deleteDelete an export.
patchPatch an export.
getList all destinations connected to the given export.
getGet the list of device groups in an application.
getGet the device group by ID.
putCreate or update a device group
deleteDelete a device group.
patchUpdate a device group via patch
getGet the devices of a device group
getGet the list of device templates in an application with basic ODATA support ($top, $filter, $orderby), [more details](https://aka.ms/iotcentralodatasupport).
getGet a device template by ID
putPublish a new device template. Default views will be automatically generated for new device templates created this way.
deleteDelete a device template
patchUpdate the cloud properties and overrides of an existing device template via patch.
getGet the list of devices in an application with basic ODATA support ($top, $filter, $orderby), [more details](https://aka.ms/iotcentralodatasupport).
getGet a device by ID
putCreate or update a device
deleteDelete a device
patchUpdate a device via patch
getGet device attestation
putCreate an individual device attestation
deleteRemove an individual device attestation
patchUpdate an individual device attestation via patch
getGet device command history
postRun a device command
getList the components present in a device
getGet component command history
postRun a component command
getGet device properties for a specific component
putReplace device properties for a specific component
patchUpdate device properties for a specific component via patch
getGet component telemetry value
getGet device credentials
getList the modules present in a device
getGet module command history
postRun a module command
getList the components present in a module
getGet module component command history
postRun a module component command
getGet module properties for a specific component
putReplace module properties for a specific component
patchUpdate module properties for a specific component via patch
getGet module component telemetry value
getGet module properties
putReplace module properties
patchUpdate module properties via patch
getGet module telemetry value
getGet device properties
putReplace device properties
patchUpdate device properties via patch
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).
getGiven the ID for a device and a relationship ID associated with this device, get the details of the relationship.
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.
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.
patchPatch a given relationship given the relationship ID and a given device ID.
getGet device telemetry value
getGet the list of enrollment groups in an application
getGet an enrollment group by ID
putCreate an enrollment group
deleteDelete an enrollment group
patchUpdate an enrollment group
getGet the primary or secondary x509 certificate of an enrollment group
putSets the primary or secondary x509 certificate of an enrollment group
deleteRemoves 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
postVerify the primary or secondary x509 certificate of an enrollment group
getGet the file upload storage account configuration.
putCreate the file upload storage account configuration.
deleteDelete the file upload storage configuration.
patchUpdate the file upload storage account configuration
getGet the list of jobs in an application
getGet a job by ID
putExecute a new job
getGet device statuses
putRerun a job on failed devices
postResume a stopped job
postStop a running job
getGet the list of organizations the user has access to in an application
getGet an organization by ID
putCreate an organization in the application
deleteDelete an organization
patchUpdate an organization in the application via patch
deleteDelete a user

Delete a user

delete/users/{userId}

Path parameters

userIdstring required

Unique ID of the user.

Query parameters

api-versionstring required

The version of the API being called.

Response

Success

Changes