Provision
Device provisioning and management APIs.
These APIs provide devices with the necessary provisioning APIs to manage communications with a device cloud.
GetCerts
Provision a device with MQTT certificates.
After a device has been claimed for management by a user into a device cloud, the device can call "getCerts" to request provisioning of MQTT certificates to secure communications.
This call returns the certificate, private key and communications endpoint to use for secure MQTT communications with the device cloud.
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | Device claim ID. |
Response
MQTT certificate and endpoints for device communications.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Manager Account ID. |
| certificate | string | X.509 certificate. |
| endpoint | string | MQTT host endpoint for communciations. |
| id | string | Device ID. |
| key | string | X.509 certificate key. |
| port | number | MQTT TCP/IP port number. |
| thing | string | AWS IoT Core thing name for the device. |
GetCreds
Get IAM credentials
Get IAM credentials for use in the device that is hosted in a dedicated cloud.
This will create temprorary IAM credentials based on the configured Cloud.deviceRole (default IotoDeviceRole).
These credentials can be used with appropriate AWS SDK or Ioto AWS Sigv4 APIs.
Endpoint
1 | |
Authorized User Role
1 | |
Response
A set of AWS IAM credentials that can be used with AWS APIs.
| Field | Type | Notes |
|---|---|---|
| accessKeyId | string | AWS access key ID. |
| secretAccessKey | string | AWS secret access key. |
| sessionToken | string | AWS credentials session token. |
| expires | date | When the credentials expire. |
| region | string | AWS region. |
Update
Device update
Check for software updates.
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
| product | string | yes |
| version | string | yes |
| test | boolean | |
| * | any |
Response
| Field | Type | Notes |
|---|---|---|
| checksum | string | Download checksum. |
| version | string | Version to update to. |
| url | string | Download URL for the software update. |
| update | string | Selected update (quote on report). |
UpdateReport
Device update report
Post update status.
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
| update | string | yes |
| success | boolean | yes |