Check API health status

GET

/health

const url = 'https://your-store.example.com/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://your-store.example.com/health

Responses

200

All subsystems are healthy

application/json

object

status

required

string

Allowed values: ok error

uptime

required

Process uptime in seconds

number

postgres

required

string

Allowed values: ok down

redis

required

string

Allowed values: ok down

meilisearch

required

string

Allowed values: ok down

storage

required

string

Allowed values: ok down

Example

{
  "status": "ok",
  "uptime": 42.5,
  "postgres": "ok",
  "redis": "ok",
  "meilisearch": "ok",
  "storage": "ok"
}

503

One or more subsystems are down