Get device by ID

GET

/api/v1/devices/{id}

const url = 'http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves detailed information about a specific device.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Device UUID

Responses

200

Device retrieved successfully

application/json

object

required

Unique device identifier (UUID)

string format: uuid

clientId

required

Client-provided device identifier

string

name

Human-readable device name

string

status

required

Current device status

string

Allowed values: ONLINE OFFLINE PENDING ERROR

capabilities

required

Device capabilities as reported during onboarding

object

key

additional properties

any

labels

required

Key-value labels for device organization and filtering

object

key

additional properties

string

lastSeenAt

Timestamp of last communication from device

string format: date-time

createdAt

required

Timestamp when device was registered

string format: date-time

updatedAt

required

Timestamp of last device update

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "clientId": "edge-device-001",
  "name": "Production Edge Gateway 1",
  "status": "ONLINE",
  "capabilities": {
    "cpu": {
      "cores": 4,
      "architecture": "arm64"
    },
    "memory": {
      "total": 8192
    },
    "containers": {
      "runtime": "containerd"
    }
  },
  "labels": {
    "environment": "production",
    "region": "us-west",
    "tier": "edge"
  },
  "lastSeenAt": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

404

Device not found