System

Retrieve an authentication token

Retrieve an authentication token to be used for API communication.

POST/v1/auth/token

Header parameters

Response

200

Success

Body

application/json

bearerTokenstring

Example: "jwtToken"

Request

JavaScriptCurlPython

const response = await fetch('/v1/auth/token', {
    method: 'POST',
    headers: {
      "clientId": "text",
      "clientSecret": "text"
    },
});
const data = await response.json();

Response

200

{
  "bearerToken": "jwtToken"
}

Check the health of the system

Check the health of the system

GET/v1/system/health

Header parameters

Response

200

Success

Body

application/json

redisServicesstring

Example: "Healthy"

databaseServicesstring

Example: "Healthy"

Request

JavaScriptCurlPython

const response = await fetch('/v1/system/health', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Response

200

{
  "redisServices": "Healthy",
  "databaseServices": "Healthy"
}