Health check

View .md OpenAPI spec Open in Claude Open in ChatGPT

GET

/health

const url = 'https://switchboard.mux.global/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://switchboard.mux.global/health

Responses

200

Up.

application/json

object

status

required

string

Allowed values: ok unavailable

key

additional properties

any

Example

{
  "status": "ok"
}

503

Up, but not ready to serve.

application/json

object

status

required

string

Allowed values: ok unavailable

key

additional properties

any

Example

{
  "status": "ok"
}