Get Device | MediaKind Docs

{
  "kind": "string",
  "metadata": {
    "id": "string",
    "created": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByEmail": "string",
    "displayName": "string",
    "labels": {
      "label1": "value1",
      "label2": "value2"
    },
    "name": "string",
    "updated": "2024-01-15T09:30:00Z",
    "updatedBy": "string",
    "updatedByEmail": "string"
  },
  "spec": {
    "availableNetworks": [
      {
        "interfaceName": "eth0",
        "networkName": "internet"
      }
    ],
    "autoPreloadLatestSoftware": true,
    "desiredSoftwareVersion": "1.0.0.0",
    "geolocation": {
      "coordinates": [
        1.1
      ]
    },
    "locationId": "e188ca13-604f-4940-9afb-c3cb952baf01",
    "preloadSoftwareVersion": "1.0.0.1",
    "shortCode": "XU7U23WD",
    "siteName": "world"
  },
  "status": {
    "alarmSeverity": 0,
    "assignedFlows": [
      {
        "name": "channel-1"
      }
    ],
    "beamHA": {
      "roles": [
        "Controller",
        "Worker",
        "Arbiter"
      ],
      "activeControllerDeviceName": "controller-01",
      "status": "OK",
      "unregisteredDevices": [
        "e188ca13-604f-4940-9afb-c3cb952baf01"
      ]
    },
    "capabilities": {
      "configurationBackup": true
    },
    "currentSoftwareVersion": "1.0.0.2",
    "geolocation": {
      "coordinates": [
        1.1
      ]
    },
    "interfaces": [
      {
        "name": "eth0",
        "state": "Present",
        "type": "IP",
        "ipAddresses": [
          "10.10.10.1"
        ]
      }
    ],
    "lastContact": "string",
    "locationId": "e188ca13-604f-4940-9afb-c3cb952baf01",
    "preloadedSoftware": [
      {
        "name": "beam",
        "state": "Downloading",
        "version": "1.0.0.0",
        "downgradeCompatible": true,
        "precentProgress": 25,
        "progressDetails": "1.2GiB of 4.9GiB",
        "upgradeCompatible": true
      }
    ],
    "rollbackSoftwareVersion": "1.0.0.1",
    "secondsSinceLastContact": 1,
    "serialNumber": "string",
    "softwareName": "beam",
    "softwareUpgradeState": "Idle",
    "url": "string"
  }
}

Get a device by name. To learn more about devices, read Device Concept.

RBAC Capability Required: fleet.device.get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired

namestringRequired

Response

A single device

kindstring

The kind of record.

metadataobject

Device metadata.

specobject

Device specification.

statusobject

Device status.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error