sortarray[string]
limitnumber
offsetnumber
Devices
Device registration, management, and monitoring
List All Devices
Retrieves a paginated list of all devices registered to the tenant with support for filtering, sorting, and search. This endpoint provides comprehensive device information including connection status, user associations, and hardware details.
get
https://public-api.cipherscale.com/qa/tenants/devices
Query Parameters
Response
application/json
Response
application/json
Successfully retrieved devices
PaginatedDto
PaginatedDtoobject
get/tenants/devices
Authentication
Query Parameters
application/json
Get Device Details
Retrieves comprehensive information about a specific device including its configuration, connection status, associated user, hardware details, and security posture information.
get
https://public-api.cipherscale.com/qa/tenants/devices/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the device
Example:123e4567-e89b-12d3-a456-426614174000
Response
application/json
Response
application/json
Successfully retrieved the device
DeviceDto
Device information including connection status, user association, and security posture
idstring(uuid)required
Unique identifier for the device
createdAtstring(date-time)required
Timestamp when the device was registered
updatedAtstring(date-time)required
Timestamp when the device information was last updated
namestringrequired
Human-readable name for the device
activebooleanrequired
Whether the device is currently active and can connect
lastConnectionstring(date-time)
Timestamp of the device’s last network connection
statusstringrequired
Current connection status of the device
Allowed values:OnlineOfflineDeactivated
userobject
Information about the user who owns this device
Show Child Parameters
hardwareIdstringrequired
Unique hardware identifier for the device
postureobject
Security posture information and compliance status
appVersionstring
Version of the Cipherscale client application installed on the device
get/tenants/devices/{id}
Authentication
Path Parameters
application/json
Remove Device
Permanently removes a device from the tenant. This operation will disconnect the device from the network and revoke all associated access permissions.
delete
https://public-api.cipherscale.com/qa/tenants/devices/{id}
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the device to delete
Response
Response
Successfully deleted the device
delete/tenants/devices/{id}
Authentication
Path Parameters
Deactivate Device
Temporarily disables a device, preventing it from connecting to the network while preserving its configuration and user association. This is useful for security incidents or temporary access restrictions.
post
https://public-api.cipherscale.com/qa/tenants/devices/{id}/deactivate
Path Parameters
idstring(uuid)required
The unique identifier (UUID) of the device to deactivate
Response
Response
Successfully deactivated the device
post/tenants/devices/{id}/deactivate