Update device

PATCH

/api/v1/devices/{id}

curl --request PATCH \
  --url http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "Production Edge Gateway 1", "labels": { "environment": "production", "region": "us-west", "tier": "edge" } }'

• Development
• Production

Updates device properties such as name and labels.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Device UUID

Request Body^required

Media typeapplication/json

object

name

Human-readable device name

string

<= 255 characters

Example

Production Edge Gateway 1

labels

Key-value labels for device organization and filtering

object

key

additional properties

string

Example

{
  "environment": "production",
  "region": "us-west",
  "tier": "edge"
}

Responses

200

Device updated successfully

Media typeapplication/json

object

id

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

reportedDeviceId

Margo self-reported DeviceId (properties.id from the device capabilities manifest). Unique per organization among non-deleted devices — null if this device has never reported capabilities, or if it collided with another device already holding the same value (FM-1043) and its write was rejected.

string

cpuUsagePercent

Latest reported CPU usage percentage (FM-770, from VictoriaMetrics). Null if the device has never reported telemetry.

number

nullable

memoryUsagePercent

Latest reported memory usage percentage (FM-770, from VictoriaMetrics). Null if the device has never reported telemetry.

number

nullable

diskUsagePercent

Latest reported disk usage percentage (FM-770, from VictoriaMetrics). Null if the device has never reported telemetry.

number

nullable

runningWorkloadCount

Count of non-removed deployment instances currently targeting this device (FM-770). Always a real count, independent of telemetry availability.

number

nullable

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",
  "reportedDeviceId": "wm-uc20-m3000-ax4b14pc7500001",
  "cpuUsagePercent": 42.5,
  "memoryUsagePercent": 67.2,
  "diskUsagePercent": 55.1,
  "runningWorkloadCount": 3
}

400

Bad Request - Invalid input data

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

404

Device not found