Skip to main content
GET
/
health
JavaScript
import MidboundCloud from '@midbound/cloud';

const client = new MidboundCloud({
  apiKey: process.env['MIDBOUND_CLOUD_API_KEY'], // This is the default and can be omitted
});

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

console.log(response.status);
{
  "status": "ok",
  "version": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Response

200 - application/json

Default Response

status
enum<string>
required

Service health status

Available options:
ok,
degraded,
unhealthy
version
string
required

API version

timestamp
string<date-time>
required

Current server timestamp (ISO)