Get a network device

get

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

device_idinteger · int64Required

ID of the network device.

Responses

200

Network device details.

application/json

added_bystringRequired

added_datestring · date-timeRequired

assigned_ipsstring[]Required

configuredbooleanRequired

descriptionstring · nullableOptional

idinteger · int64Required

namestringRequired

wireguard_pubkeystringRequired

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

404

Network device not found.

application/json

500

Unable to get network device.

application/json

get/api/v1/device/network/{device_id}

HTTPcURLJavaScriptPython

GET /api/v1/device/network/{device_id} HTTP/1.1
Accept: */*

{
  "added_by": "text",
  "added_date": "2026-08-11T03:39:43.323Z",
  "assigned_ips": [
    "text"
  ],
  "configured": true,
  "description": null,
  "id": 1,
  "location": {
    "id": 1,
    "name": "text"
  },
  "name": "text",
  "split_ips": [
    {
      "ip": "text",
      "modifiable_part": "text",
      "network_part": "text",
      "network_prefix": "text"
    }
  ],
  "wireguard_pubkey": "text"
}