Search
K
Cipherscale API

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

sortarray[string]
limitnumber

Number of items to return per page. Use with “offset” for pagination. If omitted, a default is applied. A maximum may be enforced by the server.

offsetnumber

Number of items to skip before returning results. Use with “limit”. For page-based navigation: offset = page × limit.

Response

application/json

Successfully retrieved devices

PaginatedResponse

Paginated response containing data and pagination metadata

dataarray

Array of items for the current page

totalinteger

Total number of items across all pages for the given filters. Use this with “limit” to compute total pages: totalPages = ceil(total / limit).

pageinteger

Current page index (0-based). For offset-based pagination, page = floor(offset / limit). For page[] style, this equals the N used in page[offset] = N × page[limit].

limitinteger

Number of items per page returned in this response. Mirrors the query “limit” or “page[limit]” parameter used for the request.

hasNextboolean

Whether there are more pages available

hasPreviousboolean

Whether there are previous pages available

get/tenants/devices
 
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

Successfully retrieved the device

Device

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

Example:{"id":"550e8400-e29b-41d4-a716-446655440000","email":"john.doe@company.com","firstName":"John","lastName":"Doe","lastConnection":"2023-01-15T14:30:00Z"}

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}
 
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

Successfully deleted the device

delete/tenants/devices/{id}
 

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

Successfully deactivated the device

post/tenants/devices/{id}/deactivate
 

Reactivate Device

Restores network access for a previously deactivated device. This operation allows the device to reconnect to the network with its previous configuration and permissions.

post
https://public-api.cipherscale.com/qa/tenants/devices/{id}/reactivate

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the device to reactivate

Response

Successfully reactivated the device

post/tenants/devices/{id}/reactivate