Get Workspace Asset Division Device

GET 
/api/v1/workspaces/:workspace/assets/:asset/divisions/:division/devices/:device

Get a Device in a Workspace/Asset/Division group by their Names.

Request

Path Parameters

workspace stringrequired

Name of the Workspace

asset stringrequired

Name of the Asset

division stringrequired

Name of the Division

device stringrequired

Name of the Device

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Device
Possible values: > 0
Example: 1000
name stringrequired
Name of the Device
Example: Device 1
createdAt date-timerequired
Creation Date of the Device
Example: 2025-03-12T18:12:44.465Z
updatedAt date-timerequired
Update Date of the Device
Example: 2025-03-12T18:12:44.465Z
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

workspace

object

id integerrequired

ID of the Workspace

Possible values: > 0

Example: 1000

name stringrequired

Name of the Workspace

Example: Workspace 1

asset

object

id integerrequired

ID of the Asset

Possible values: > 0

Example: 1000

name stringrequired

Name of the Asset

Example: Asset 1

division

object

id integerrequired

ID of the Division

Possible values: > 0

Example: 1000

name stringrequired

Name of the Division

Example: Division 1

Example (from schema)

{
  "id": 1000,
  "name": "Device 1",
  "createdAt": "2025-03-12T18:12:44.465Z",
  "updatedAt": "2025-03-12T18:12:44.465Z",
  "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"
  },
  "workspace": {
    "id": 1000,
    "name": "Workspace 1"
  },
  "asset": {
    "id": 1000,
    "name": "Asset 1"
  },
  "division": {
    "id": 1000,
    "name": "Division 1"
  }
}

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"
}

404

Device not found

application/json

Schema

Schema

status stringrequired

Possible values: [Device not found]

Example (from schema)

{
  "status": "Device not found"
}

Loading...