health

System status

Returns detailed system status (uptime, memory, CPU, service health). Requires project JWT or API key. Used for admin or monitoring dashboards.

GET/api/status

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

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

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

Try It Live

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

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Detailed system status
json
{
  "success": true,
  "data": {
    "uptime": 86400,
    "memory": {
      "used": 2147483648,
      "total": 4294967296,
      "percentage": 50
    },
    "cpu": {
      "usage": 12.5
    },
    "services": {
      "database": "operational",
      "redis": "operational",
      "storage": "operational",
      "messaging": "operational"
    }
  }
}
{
  "success": true,
  "data": {
    "uptime": 86400,
    "memory": {
      "used": 2147483648,
      "total": 4294967296,
      "percentage": 50
    },
    "cpu": {
      "usage": 12.5
    },
    "services": {
      "database": "operational",
      "redis": "operational",
      "storage": "operational",
      "messaging": "operational"
    }
  }
}
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