getSystemHealth

GET

/api/v1/system/health

const url = 'https://example.com/api/v1/system/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/system/health

Read system health. Requires an Owner or Administrator with the read scope.

Responses

200

System health

application/json

object

data

required

object

status

required

string

Allowed values: ok

service

required

string

Allowed values: tilecast-server

Example

{
  "data": {
    "status": "ok",
    "service": "tilecast-server"
  }
}

401

Dashboard authentication required

403

Insufficient role