Waiting for engine...
Skip to main content

Knowledge Hub Retrieve APIs - health

Updated 
Toggle Pane

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

health

Service health checks

Health check

Health check endpoint.

Returns the health status of the API service with version and uptime.

Responses

Response Schema: application/json
status
required
string (Status)

Service health status

version
required
string (Version)

Service version

uptime_seconds
required
integer (Uptime Seconds)

Seconds since service start

Response samples

Content type
application/json
{
  • "status": "healthy",
  • "uptime_seconds": 3600,
  • "version": "1.0.0"
}

Liveness check

Liveness probe endpoint.

Simple check that returns 200 if the process is running. Used by Kubernetes liveness probes.

Responses

Response Schema: application/json
status
required
string (Status)

Probe status

Response samples

Content type
application/json
{
  • "status": "ok"
}

Readiness check

Readiness probe endpoint.

Returns 200 when the service is ready to accept traffic. Used by Kubernetes readiness probes.

Responses

Response Schema: application/json
status
required
string (Status)

Probe status

Response samples

Content type
application/json
{
  • "status": "ok"
}