health

Parameters

No parameters.

Responses

• 200The API, its database and its secrets provider are up

  • statusstringrequired
    • enum: "ok"
  • versionstringrequired
  • databasestringrequired
    • enum: "ok", "down"
  • secretsstringrequired

    Last KMS round trip on a test envelope (at boot, then every 5 minutes)

    • enum: "ok", "down"
  • outboxany | nullrequired

    Null when the database is down

• 503The database or the secrets provider is unreachable

  • statusstringrequired
    • enum: "ok"
  • versionstringrequired
  • databasestringrequired
    • enum: "ok", "down"
  • secretsstringrequired

    Last KMS round trip on a test envelope (at boot, then every 5 minutes)

    • enum: "ok", "down"
  • outboxany | nullrequired

    Null when the database is down

Code samples

curl -X GET "$KONNECT_API_URL/health"

Example: 200

{
  "status": "ok",
  "version": "0.1.0",
  "database": "ok",
  "secrets": "ok",
  "outbox": {
    "due": 1,
    "failed": 1
  }
}

Example: 503

{
  "status": "ok",
  "version": "0.1.0",
  "database": "ok",
  "secrets": "ok",
  "outbox": {
    "due": 1,
    "failed": 1
  }
}