Skip to main content

Delete Device

Delete Device API will delete the user DeviceID.

Resource Informations

NameValue
Requires authentication?Yes
Rate limited?No

Request

Request headers

KeyValue
AuthorizationBearer token
Content-Typeapplication/json

HTTP request URL for SSMS

DELETE https://{tenantId}.{hostname}/digitanium/v4/devices/{deviceid}

HTTP request URL for SHIFT

DELETE https://{hostname}/auth/realms/{tenantId}/v3_device/{deviceid}
note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body

No request body fields are required.

Response

Field NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem categorizes the type of API that has been called. Refer Subsystem details for details.
dataBooleantrue - when device is locked, false - when device is already locked, null - when device does not exist.

Sample Response

{
"subSystem": 6,
"status": "OK",
"message": "DeviceId deleted successfully.",
"data": true
}

Response Status Information

Status CodeStatusMessage
200OKDeviceId deleted successfully.
400DEVICE_PARAMETER_INVALIDError, either the device parameter 'deviceID' must have a positive value, or the 'issuerDN' and 'serial number' must not be null or empty.
401UnauthorizedHTTP 401 Unauthorized.
404DEVICEID_NOT_FOUNDDeviceId does not exist.