Use this endpoint to get a list of records with information about your devices.
curl -X GET \
'https://one.digicert.com/iot/api/v2/device?limit=1&offset=11' \
-H 'x-api-key: {{api_key}}'
{
"limit": 1,
"offset": 11,
"total": 89,
"records": [
{
"id": {{device_id}},
"account_id": {{account_id}},
"division": {
"id": {{division_id}},
"name": "division"
},
"device_identifier": "Device 013 6",
"device_profile": {
"id": {{device_profile_id}},
"name": "Device Profile Test 1 field"
},
"created": "2020-06-30T08:43:25Z",
"updated": "2020-06-30T16:51:08Z",
"status": "ACTIVE",
"fields": [
{
"id": {{field_id}},
"name": "Color",
"value": "256G2 6",
"mandatory": false
}
],
"device_api_allow_read": true,
"device_api_allow_write": true,
"device_api_allow_renew_certificate": true
}
]
}
Name | Req/Opt | Type | Description |
---|---|---|---|
device_identifier | optional | string | Limits response data to records that use a specific device identifier. |
created_from | optional | string |
Limits response data to device records created after a specific date. Format: YYYY-MM-DD
|
created_to | optional | string |
Limits response data to device records created before a specific date. Format: YYYY-MM-DD
|
division_id | optional | string | Limits response data to device records associated with a specific division ID. |
updated_from | optional | string |
Limits response data to device records updated after a specific date. Format: YYYY-MM-DD
|
upated_to | optional | string |
Limits response data to device records updated before a specific date. Format: YYYY-MM-DD
|
device_profile_id | optional | string | Limits response data to device records with a specific device profile ID. |
limit | optional | int |
Number of device records to include in the results. Default: 20
|
offset | optional | int |
Offset index of the first device record to include in the results. Default: 0
|
Name | Type | Description |
---|---|---|
limit | int | Limit on the number of device records included in the results. |
offset | int | Offset index of the first device record included in the results. |
total | int | Total number of device records found. |
records | array | List of device record objects. Each object includes the key/value pairs described below. |
.. id | string | Device ID. |
.. account_id | string | Account ID. |
.. division | object | Details about the division the device belongs to. |
.. .. id | string | Division ID. |
.. .. name | string | Division name. |
.. device_identifier | string | Unique device name. |
.. device_profile | object | Details about the device profile. |
.. .. id | string | Device profile ID. |
.. .. name | string | Device profile name. |
.. created | string | Date and time (UTC) device was created. |
.. updated | string | Date and time (UTC) device was last updated. |
.. status | string | Device status. |
.. fields | array | Array of objects with details about the device's attributes and settings. Fields are declared in the device profile. |
.. .. id | string | Unique field ID. |
.. .. name | string | Field name. |
.. .. value | string | Field value. |
.. .. mandatory | bool | Whether or not the field is required, based on the device profile. |
.. device_api_allow_read | boolean |
Whether the device can read its own device information. This setting applies to calls on the Get device details by ID (client authentication) endpoint that use TLS authentication. |
.. device_api_allow_write | boolean |
Whether the device can update its own device information. This setting applies to calls on the Update device by ID (client authentication) endpoint that use TLS authentication. |
.. device_api_allow_renew_certificate | boolean |
Whether the device can renew its own certificates. This setting applies to calls on the Renew device certificate by device ID (client authentication) endpoint that use TLS authentication. |