Release a reportedDeviceId claim

POST

/api/v1/devices/{id}/release-reported-device-id

const url = 'http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000/release-reported-device-id';
const options = {method: 'POST', 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 POST \
  --url http://localhost:3000/api/v1/devices/550e8400-e29b-41d4-a716-446655440000/release-reported-device-id \
  --header 'X-API-Key: <X-API-Key>'

FM-1043: clears this device’s reportedDeviceId (the Margo self-reported DeviceId from its capabilities manifest) without soft-deleting the device. Recovery action for an ID-squatting collision — use when the rejection-audit trail shows this device is holding a DeviceId that belongs to another device, so the true owner’s next capabilities report can claim it.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

Device UUID

Responses

200

ReportedDeviceId claim released 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

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
}

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

404

Device not found