Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Devices

Get device

get/v1/device/{device_id}

Path parameters

device_idstring required

ID of a device

Example:d_0123456789ab

Response

OK

booted_atstring date-time

Boot timestamp

client_idstring

ID of a client

device_idstring required

ID of a device

device_warranty_expiration_datestring date-time required

Warranty expiration date of the device

display_namestring required

Customizable display name

hardware_model_namestring required

Hardware model name of the device

hostnamestring required

Hostname of the system

image_versionstring required

Version of the device image

ip_addressesstring[] required

This field is deprecated and will be removed in the future.

last_seen_atstring date-time required

Last seen timestamp

network_update_pendingboolean

Whether the device has a network update pending

nfrboolean required

Whether the device is an NFR device

package_versionstring required

Version of the Slide package

public_ip_addressstring ipv4 required

Public IP address of the device

serial_numberstring required

Serial number of the device

service_model_namestring required

Service model name of the device

service_model_name_shortstring required

Short service model name of the device

service_status'pending_activation' | 'active' | 'canceled' required

Status of the service

storage_total_bytesinteger required

Total storage in bytes

storage_used_bytesinteger required

Used storage in bytes

total_agent_included_volume_used_bytesinteger required

Amount of data currently on the device's Protected Systems

Example response

{
  "addresses": [
    {
      "ips": [
        "192.168.1.104"
      ],
      "mac": "62:bb:d3:0d:db:7d"
    }
  ],
  "booted_at": "2024-08-23T01:25:08Z",
  "client_id": "c_0123456789ab",
  "device_id": "d_0123456789ab",
  "device_warranty_expiration_date": "2029-08-23T01:25:08Z",
  "display_name": "My First Device",
  "hardware_model_name": "Slide Z1, 1 TB",
  "hostname": "my-hostname-1",
  "image_version": "1.0.0",
  "ip_addresses": [
    "192.168.3.53"
  ],
  "last_seen_at": "2024-08-23T01:25:08Z",
  "package_version": "1.2.3",
  "public_ip_address": "74.83.124.111",
  "serial_number": "SN123456",
  "service_model_name": "Slide Z1 Subscription, 1 TB, 1 Year Cloud Retention",
  "service_model_name_short": "1 Year Cloud Retention",
  "service_status": "active",
  "storage_total_bytes": 1099511627776,
  "storage_used_bytes": 274877906944,
  "total_agent_included_volume_used_bytes": 274877906944
}