System

Retrieve an authentication token

Retrieve an authentication token to be used for API communication.

post

/v1/auth/token

Authorizations

Header parameters

clientIdstringrequired

clientSecretstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/auth/token' \
  --header 'Authorization: Bearer JWT' \
  --header 'clientId: text' \
  --header 'clientSecret: text'

200

200

{
  "bearerToken": "jwtToken"
}

Success

Check the health of the system

Check the health of the system

get

/v1/system/health

Authorizations

Header parameters

Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/system/health' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'

200

200

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

Success