Get server health status

curl --request GET \
  --url https://api.letraz.app/api/v1/health/

{
  "instance_id": "<string>",
  "status": "OPERATIONAL",
  "details": {
    "sentry": "OPERATIONAL",
    "clerk": "OPERATIONAL",
    "db": "OPERATIONAL",
    "util_service": "OPERATIONAL"
  }
}

GET

health

curl --request GET \
  --url https://api.letraz.app/api/v1/health/

{
  "instance_id": "<string>",
  "status": "OPERATIONAL",
  "details": {
    "sentry": "OPERATIONAL",
    "clerk": "OPERATIONAL",
    "db": "OPERATIONAL",
    "util_service": "OPERATIONAL"
  }
}

Response

instance_id

string

required

The id of the instance from which the health check response has been received.

status

enum<string>

required

The health status of the server. The status can be ok, degraded or failing.

OPERATIONAL - OPERATIONAL
DEGRADED - DEGRADED

Available options:

OPERATIONAL,

DEGRADED

details

object

required

Show child attributes

details.sentry

enum<string>

required

The status of the sentry integration. If False, the sentry is not initialized, possibly due to absense of environment variables, which is expected or misconfigured initialization.

OPERATIONAL - OPERATIONAL
UNINITIALIZED - UNINITIALIZED
FAILED - FAILED

Available options:

OPERATIONAL,

UNINITIALIZED,

FAILED

details.clerk

enum<string>

required

The health status of Clerk integration. The status can be OPERATIONAL or DOWN.

OPERATIONAL - OPERATIONAL
DOWN - DOWN

Available options:

OPERATIONAL,

DOWN

details.db

enum<string>

required

The health status of Clerk connection. The status can be OPERATIONAL, DEGRADED or FATAL.

OPERATIONAL - OPERATIONAL
DEGRADED - DEGRADED
FATAL - FATAL

Available options:

OPERATIONAL,

DEGRADED,

FATAL

details.util_service

enum<string>

required

The health status of gRPC:util connection. The status can be OPERATIONAL, DISCONNECTED or FAILED.

OPERATIONAL - OPERATIONAL
DISCONNECTED - DISCONNECTED
FAILED - FAILED

Available options:

OPERATIONAL,

DISCONNECTED,

FAILED

Data Fetching Get sample error

⌘I

Get Started

Documents

Architecture

API References

Get server health status

Response