Skip to main content

Get Device

GET 
/api/v1/devices/:device

Get a Device by its ID.

Request​

Path Parameters

    device integerrequired

    Possible values: > 0

    ID of the Device

Responses​

Success

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
Loading...