health

Health check

Liveness/readiness probe for load balancers and orchestrators. Returns status of core services (database, redis, storage, email, sms). No authentication required. Use for uptime checks and deployment health gates.

GET/health

Authentication

Public — No Auth Required

SDK setup

Create a client instance. No authentication is required for this endpoint.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.health.check();
const result = await client.health.check();

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

No Request Yet

Send a request to see the full inspector

Responses

200System health status
json
{
  "status": "healthy",
  "timestamp": "2024-01-15T10:00:00.000Z",
  "services": {
    "database": "healthy",
    "redis": "healthy",
    "storage": "healthy",
    "email": "healthy",
    "sms": "healthy"
  },
  "version": "1.0.0",
  "uptime": 3600
}
{
  "status": "healthy",
  "timestamp": "2024-01-15T10:00:00.000Z",
  "services": {
    "database": "healthy",
    "redis": "healthy",
    "storage": "healthy",
    "email": "healthy",
    "sms": "healthy"
  },
  "version": "1.0.0",
  "uptime": 3600
}
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub