GET Server Health

Get information about the overall health of the server

Description

Use the GET method to determine whether the server is healthy and able to process HTTP requests.

The server is healthy if it has a valid license or has lost communication with the network license manager but is still within the grace period specified by the license-grace-period property.

Request

HTTP Method

GET

URI

http://host:port/api/health

Response

Success

HTTP Status Code

200 OK

Body

Name Description Value-Type

Name	Description	Value-Type
`status`	Status of server.	ok

status

Status of server.

ok

Example:

{
  "status": "ok"
}

Error

HTTP Status Code

503 Health check failed

Sample Call

HTTP

Request:

GET /api/health HTTP/1.1
Host: localhost:9910

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "ok"
}

JavaScript

var data = null;
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://localhost:9910/api/health");
xhr.send(data);

Version History

Introduced in R2019b