Device

Device management and operations API

get

https://localhost:3000/apihttp://localhost:3000/api

/Devices/links

Get all network links with source and destination device information, interface details, and transceiver info

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Devices/links

HTTPcURLJavaScriptPython

GET /api/Devices/links HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Devices/transceiverInfo

Get transceiver details for a specific interface on a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "fromDate" : "2026-01-23 04:25:14",
 "toDate" : "2026-01-23 05:25:14",
 "windowSize" : "1 hour",
 "deviceAddress" : "02:42:0a:00:15:51",
 "ifName" : "Ethernet1"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Devices/transceiverInfo

HTTPcURLJavaScriptPython

GET /api/Devices/transceiverInfo?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Devices/transceiverMega

Get combined transceiver data including RX Power, TX Power, Temperature and Voltage for a specific interface

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "fromDate" : "2026-01-23 04:25:14",
 "toDate" : "2026-01-23 05:25:14",
 "windowSize" : "1 hour",
 "deviceAddress" : "02:42:0a:00:15:51",
 "ifName" : "Ethernet1"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Devices/transceiverMega

HTTPcURLJavaScriptPython

GET /api/Devices/transceiverMega?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/device/reboot

Initiates reboot process for specified devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/device/reboot

HTTPcURLJavaScriptPython

POST /api/device/reboot HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "type": "object",
  "properties": {
    "IPs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/device/runZTP

Initiates Zero Touch Provisioning (ZTP) upgrade process for specified devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/device/runZTP

HTTPcURLJavaScriptPython

POST /api/device/runZTP HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "type": "object",
  "properties": {
    "IPs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/device/customUpgrade

Initiates custom NOS image upgrade for specified devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/device/customUpgrade

HTTPcURLJavaScriptPython

POST /api/device/customUpgrade HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "type": "object",
  "properties": {
    "IPsAndImage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ip": {
            "type": "string"
          },
          "image": {
            "type": "string"
          }
        }
      }
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/device/hostLogs

Retrieves intent derivation logs for a specific device from Fabric Manager.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/device/hostLogs

HTTPcURLJavaScriptPython

POST /api/device/hostLogs HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "type": "object",
  "properties": {
    "device": {
      "type": "string",
      "examples": null
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/Device/removeDevices

Removes devices from the inventory by their IP addresses.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: array

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/Device/removeDevices

HTTPcURLJavaScriptPython

POST /api/Device/removeDevices HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/Device

Adds new devices to the inventory from YAML or JSON configuration data.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/Device

HTTPcURLJavaScriptPython

POST /api/Device HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "type": "object",
  "properties": {
    "str": {
      "type": "string",
      "description": "YAML string configuration"
    },
    "devJson": {
      "type": "string",
      "description": "JSON string configuration"
    },
    "instance": {
      "type": "string",
      "description": "Instance identifier"
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/transceiverDetails

Returns detailed transceiver information for a specific device and interface.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "02:42:0a:00:15:20",
 "name" : "Ethernet1"
}

Note: deviceAddress accepts IP or Mac address. name is the interface name.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/transceiverDetails

HTTPcURLJavaScriptPython

GET /api/Device/transceiverDetails?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/deviceListTelemetryVersionAndFMVersion

Returns list of devices with their telemetry agent versions and Fabric Manager versions.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/deviceListTelemetryVersionAndFMVersion

HTTPcURLJavaScriptPython

GET /api/Device/deviceListTelemetryVersionAndFMVersion HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/interfaces

Get list of all devices with their interface names and aliases

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/interfaces

HTTPcURLJavaScriptPython

GET /api/Device/interfaces HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/gpulist

Get list of all devices with their GPU names and UUIDs

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/gpulist

HTTPcURLJavaScriptPython

GET /api/Device/gpulist HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/docker-containers

Get list of all unique Docker container names across all devices

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/docker-containers

HTTPcURLJavaScriptPython

GET /api/Device/docker-containers HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/Device/gpu-stats

Returns GPU statistics including utilization, memory usage, temperature, and health status for devices.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Device/gpu-stats

HTTPcURLJavaScriptPython

GET /api/Device/gpu-stats HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/device/imageManagementStatus

Get image management status for devices including upgrade and reboot status

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

neededIPsstringOptional

JSON array of device IPs to check status

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/device/imageManagementStatus

HTTPcURLJavaScriptPython

GET /api/device/imageManagementStatus HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content