Health

List of Device Health API.

get

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

/health/DeviceList

Returns list of devices with their health metrics 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/DeviceList

HTTPcURLJavaScriptPython

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

No content

get

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

/health/deviceInfo

Returns comprehensive device information including CPU utilization, memory utilization, temperature, and service count.

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/deviceInfo

HTTPcURLJavaScriptPython

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

No content

get

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

/health/mega

Returns comprehensive health metrics for a device including CPU, memory, services, temperature, PSU, fan, and SSD statistics.

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/mega

HTTPcURLJavaScriptPython

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

No content

get

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

/health/topCpuConsumingServices

Returns list of services consuming the most CPU resources 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/topCpuConsumingServices

HTTPcURLJavaScriptPython

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

No content

get

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

/health/fabricWiseHealth

Returns fabric-wise health status including healthy and unhealthy device counts per fabric and region.

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/fabricWiseHealth

HTTPcURLJavaScriptPython

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

No content