Skip to main content

List Workspace Devices

GET 
/api/v1/workspaces/:workspace/devices

List all Devices in a Workspace by its ID.

Request​

Path Parameters

    workspace integerrequired

    Possible values: > 0

    ID of the Workspace

Query Parameters

    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​

Success

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

    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: /workspaces/1000/devices/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K
Loading...