Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

API documentation

General

Health check

Get Unimus health status.

Method: GET

Panel
borderColorgrey
borderStylesolid

http://example.unimus/api/v1/heatlh

CURL

Panel
borderColorgrey
borderStylesolid

curl -H "Accept: application/json" -H "Authorization: Bearer <token>" "http://<example.unimus>/api/v1/health"

Success 200

FieldTypeDescription
statusString

OK - Unimus is ready to handle all requests.

LICENSING_UNREACHABLE - License server is unreachable. All request will proceed except add, remove and update device.

ERROR - Unimus require user interaction to solve the problem. All requests will be refused.

 

 

Panel
borderColorgrey
borderStylesolid
titleSuccess response

 HTTP/1.1 200 OK

{

"data": {
"status": "OK"
}

}