Public¶

Health Check¶

PythonJavaScript

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/health', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('/v1/health',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /v1/health

Health check endpoint.

Verifies that the API is running and can connect to the database. Returns degraded status if database connectivity fails.

Args: db: Database session dependency.

Returns: HealthResponse with API and database status.

Example responses

200 Response

{
  "service": "string",
  "status": "string",
  "database": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	HealthResponse

Success

This operation does not require authentication

Liveness Check¶

PythonJavaScript

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/health/live', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('/v1/health/live',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /v1/health/live

Liveness probe endpoint.

Simple HTTP ping for container health checks. Returns immediately without checking database or other dependencies.

Example responses

200 Response

{
  "property1": "string",
  "property2": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

Response Schema¶

Status Code 200

Response Liveness Check V1 Health Live Get

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Success

This operation does not require authentication

Root¶

PythonJavaScript

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/v1/', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('/v1/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /v1/

Root endpoint.

Returns basic API information including version and documentation URL.

Returns: Dict containing API metadata.

Example responses

200 Response

null

Responses¶

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

Response Schema¶

Success

This operation does not require authentication