Get Device

gethttps://app.mk.io/api/v1/projects/:project_name/fleet/devices/:name

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

200A single device

Loading schema details…

Errors

400Bad Request

Loading schema details…

401Unauthorized

Loading schema details…

403Forbidden

Loading schema details…

404Not Found

Loading schema details…

429Too Many Requests

Loading schema details…

500Internal Server Error

Loading schema details…

get/api/v1/projects/{project_name}/fleet/devices/{name}

curl -X GET "https://app.mk.io/api/v1/projects/{project_name}/fleet/devices/{name}" \
  -H "Authorization: Bearer <token>"

200A single device

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