GET /api/v1/health

Service health. Service status. Generated from the OpenAPI file.

Last updated 2026-11-03

Overview

GET https://api.inlineshield.io/api/v1/health

Whether the API and its database are up. No authentication.

No API key. This endpoint is public.

No request body.

cURL

curl https://api.inlineshield.io/api/v1/health

Operational.

Field	Type	Required	Description
`status`	string	yes	Values: `operational, degraded`
`database`	object	yes
`database.status`	string	yes	Values: `connected, disconnected`

operational

{
  "status": "operational",
  "database": {
    "status": "connected"
  }
}

Degraded.

Field	Type	Required	Description
`status`	string	yes	Values: `operational, degraded`
`database`	object	yes
`database.status`	string	yes	Values: `connected, disconnected`

degraded

{
  "status": "degraded",
  "database": {
    "status": "disconnected"
  }
}

Errors are JSON, { "error": "CODE", "message": "…" }. Branch on error, never on message.

HTTP status	error	When
`503`	–	Degraded.

See all errors for every endpoint.

This endpoint sends no rate-limit or quota headers. See Rate limits and quotas.