Health check

Health check

curl --request GET \
  --url https://vortexpdf.com/api/v1/health \
  --header 'Authorization: Bearer <token>'

{
  "current_user": {
    "email": "[email protected]",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "status": "operational"
}

GET

api

health

Health check

curl --request GET \
  --url https://vortexpdf.com/api/v1/health \
  --header 'Authorization: Bearer <token>'

{
  "current_user": {
    "email": "[email protected]",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "status": "operational"
}

Authorization

string

header

required

Health status

Response from the health check endpoint

current_user

object

required

Information about the authenticated user

Show child attributes

current_user.email

string<email>

required

The current user email

current_user.id

string<uuid>

required

The current user ID

status

enum<string>

required

The current health status of the API

Available options:

operational,

degraded,

major

⌘I