System

Retrieve an authentication token

post

Retrieve an authentication token to be used for API communication.

Header parameters

clientIdstring · uuidRequired

clientSecretstringRequired

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v1/auth/token

HTTPcURLJavaScriptPython

POST /v1/auth/token HTTP/1.1
Host: 
clientId: 123e4567-e89b-12d3-a456-426614174000
clientSecret: text
Accept: */*

{
  "bearerToken": "jwtToken"
}

Check the health of the system

get

Check the health of the system

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses

200

Success

application/json

get

/v1/system/health

HTTPcURLJavaScriptPython

GET /v1/system/health HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

200

Success

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