Get Shadow

This endpoint gets the device shadow.

URL

https://{{HOST}}/security/device/{deviceId}/shadow?v={version}

Method

GET

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Path Parameters

|Name|Description|Type|
|deviceId|The id of the device|string|

URL Query Parameters

Name Description Example Type
v
optional		 Version of the api to use /device?v=2.0 number

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token
Content-Type
required		 application/json Content Type

Example

Request

curl -X GET 
  'https://{{HOST}}/securityapi/device/testDevice/shadow?v=2.0' 
  -H 'Authorization: Bearer {access_token}'

Response

{
    "revision": 6,
    "hash": "UawNMypV+NFQAdmLokDo0/QU7bZUUVDc+iop93yltcg=",
    "schemaVersion": 1,
    "deviceType": 0
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
revision Description object definition
hash Description object definition
schemaVersion Description object definition
deviceType Description object definition