Search
K
Cipherscale API

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}
  
curl --request GET \
  --url https://public-api.cipherscale.com/qa/tenants/devices/123e4567-e89b-12d3-a456-426614174000 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
{
  "id": "id",
  "createdAt": "createdAt",
  "updatedAt": "updatedAt",
  "name": "name",
  "active": false,
  "lastConnection": "lastConnection",
  "status": "Online",
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "john.doe@company.com",
    "firstName": "John",
    "lastName": "Doe",
    "lastConnection": "2023-01-15T14:30:00Z"
  },
  "hardwareId": "hardwareId",
  "posture": {},
  "appVersion": "appVersion"
}

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}
  
curl --request DELETE \
  --url https://public-api.cipherscale.com/qa/tenants/devices/ \
  --header 'Content-Type: application/json'
Successfully deleted the device

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
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/devices//deactivate \
  --header 'Content-Type: application/json'
Successfully deactivated the device

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
  
curl --request POST \
  --url https://public-api.cipherscale.com/qa/tenants/devices//reactivate \
  --header 'Content-Type: application/json'
Successfully reactivated the device

Gateways

Network gateway configuration and management