Health

List of Device Health API.

get

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

/health/device-top-cpu-util

Get the list of services consuming the most CPU on a specific device.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringOptional

"68:21:5F:A6:61:72"

Note: Device MAC address as string.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/health/device-top-cpu-util

HTTPcURLJavaScriptPython

GET /api/health/device-top-cpu-util HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

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

/health/devices-health

Get list of devices with their health and status information.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/health/devices-health

HTTPcURLJavaScriptPython

GET /api/health/devices-health HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

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

/health/devices-health-detail

Get list of devices with their health and status information in detail.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/health/devices-health-detail

HTTPcURLJavaScriptPython

GET /api/health/devices-health-detail HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

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

/health/fabric-health

Get Fabric wide health status in the network

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/health/fabric-health

HTTPcURLJavaScriptPython

GET /api/health/fabric-health HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content