Delete Shadow

You can use this API to update the thing shadow for the specified thing. Updates affect only the fields specified in the request state document. Any field with a value of null is removed from the thing shadow.

Authorization: Tenant Cookie or Admin Scope or Register Scope

If you are not an admin, the calling user must be linked to the device, either directly or through a group.

URL

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

Method

DELETE

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Path Parameters

Name Description Type
deviceId
required		 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

Example

Request

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

Response

TODO JSON Response

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition