health

Paramètres

Aucun paramètre.

Réponses

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

  • statusstringobligatoire
    • enum: "ok"
  • versionstringobligatoire
  • databasestringobligatoire
    • enum: "ok", "down"
  • secretsstringobligatoire

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

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

    Null when the database is down

• 503The database or the secrets provider is unreachable

  • statusstringobligatoire
    • enum: "ok"
  • versionstringobligatoire
  • databasestringobligatoire
    • enum: "ok", "down"
  • secretsstringobligatoire

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

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

    Null when the database is down

Exemples de code

curl -X GET "$KONNECT_API_URL/health"

Exemple : 200

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

Exemple : 503

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