List Devices

GET 
/api/v1/devices

List all Devices.

Request

Query Parameters

workspaceId integer

Possible values: > 0

ID of the Workspace

workspaceName string

Name of the Workspace

divisionId integer

Possible values: > 0

ID of the Division

divisionName string

Name of the Division

assetId integer

Possible values: > 0

ID of the Asset

assetName string

Name of the Asset

workspaceMarkedForDeletion boolean

Workspaces marked for deletion

assetDisabled boolean

Asset Disabled

decomissioned boolean

Decommissioned Device

netbirdIp string

Netbird IP address

netbirdDomain string

Netbird domain for the Device

macAddress string

Possible values: Value must match regular expression ^([0-9a-f]{2}:){5}([0-9a-f]{2})$

MAC address

size integer
Possible values: > 0 and <= 100
Default value: 100
nextToken string
sortBy string

Possible values: [id, name, type, onboarded, macAddresses, netbird]

sortOrder string
Possible values: [asc, desc]
Default value: asc

Responses

200

Success

application/json

Schema

Schema

size integerrequired
Possible values: > 0
Example: 100

data

object[]

required

Array [

id integerrequired

ID of the Device

Possible values: > 0

Example: 1000

name stringrequired

Name of the Device

Example: Device 1

type stringrequired

Type of the Device

Possible values: [EdatecEDIPC2630, WagoPFC300, WagoPFC200, WagoPFC100, WagoCC100, PLCNextAXCF2152, WagoEdgeIPC, SiemensIPC127, WeidmullerUC20SL2000EC, WeidmullerUV20BIPC10xx, RUT300, HD67644A1, Flex, Virtual, VirtualMachineDebian12, VirtualAwsEC2Ubuntu, WestermoL210, Generic]

Example: WagoEdgeIPC

onboarded booleanrequired

Is the Device onboarded

Example: true

macAddresses string[]

MAC addresses for this Device

Possible values: Value must match regular expression ^([0-9a-f]{2}:){5}([0-9a-f]{2})$

Example: ["11:22:33:44:55:66","77:88:99:AA:BB:CC"]

netbird

object

Netbird information for this Device

ip stringnullablerequired

IP address

domain stringnullablerequired

Domain name of the Device

Example: device-name.netbird.cloud

]

next

object

token stringrequired

Example: eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

href urirequired

Example: /devices/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

Example (from schema)

{
  "size": 100,
  "data": [
    {
      "id": 1000,
      "name": "Device 1",
      "type": "WagoEdgeIPC",
      "onboarded": true,
      "macAddresses": [
        "11:22:33:44:55:66",
        "77:88:99:AA:BB:CC"
      ],
      "netbird": {
        "ip": "string",
        "domain": "device-name.netbird.cloud"
      }
    }
  ],
  "next": {
    "token": "eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K",
    "href": "/devices/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K"
  }
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

Loading...