PorticoDocs

Health

Generated health operations.

GET/health/liveRead server livenessopen
Audience
Integrations · Native API
Authorization
No credential needed
OpenAPI operation ID
get_health_live

Responses

200Successapplication/json

Example
{
  "alive": true
}
Schema
  • alivebooleanrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/health/live"
GET/health/readyRead server readinessopen
Audience
Integrations · Native API
Authorization
No credential needed
OpenAPI operation ID
get_health_ready

Responses

200Successapplication/json

Example
{
  "ready": true
}
Schema
  • readybooleanrequired

503Successapplication/json

Example
{
  "ready": true
}
Schema
  • readybooleanrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/health/ready"