Operation
Revoke device
POST
/devices/{deviceId}/revokeRevoke a device and kill its credentials immediately.
Path parameters
deviceIdstringRequired
Headers
Idempotency-KeystringOptional- Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.
Returns
Device revoked
Errors
- 400
- Bad Request - Invalid input
- 401
- Unauthorized - Authentication required
- 403
- Forbidden - Insufficient permissions
- 404
- Not Found - Resource not found
- 500
- Internal Server Error
Every error names its code and links to it. All error codes
curl -X POST "https://api.ticketlayer.com/v1/devices/{deviceId}/revoke" \ -H "Authorization: Bearer tlak_..." \ -H "X-Ticketlayer-Org: your-org-slug"Response 200
{
"device": {
"id": "string",
"name": "string",
"type": "string",
"status": "string",
"connectivity": "string",
"accountId": "string",
"location": {
"id": "string",
"name": "string"
},
"hostDeviceId": "string",
"attachment": "string",
"clientKey": "string",
"vendor": "string",
"model": "string",
"capabilities": {},
"liveStatus": {},
"platform": {},
"appVersion": "string",
"local": {
"hostname": "string",
"port": 0
},
"lastSeenAt": "string",
"online": true,
"createdAt": "string",
"updatedAt": "string",
"peripherals": [
{
"id": "string",
"name": "string",
"type": "string"
}
]
}
}