Skip to content

Signing backend health and telemetry

GET
/health/signing
curl --request GET \
--url https://localhost:8080/health/signing

Checks OpenBao seal state, self capabilities, platform metadata and its committed association without signing. Independent of liveness and database readiness. Other providers report not_supported. Telemetry covers process-lifetime Transit sign attempts, excluding metadata resolution; latency_buckets are cumulative upper bounds.

OK

Media type application/json

Signing backend state (ready, not_supported, uninitialized, sealed, denied, unreachable, timeout, canceled, association_mismatch, unavailable) with process-lifetime Transit signing telemetry. Only ready and not_supported return HTTP 200.

object
status
string
Allowed values: ready not_supported uninitialized sealed denied unreachable timeout canceled association_mismatch unavailable
telemetry
object
duration_seconds

DurationSeconds is the total time spent in signing attempts.

number
failures

Failures counts every attempt whose outcome is not success.

integer
latency_buckets

LatencyBuckets are cumulative: each entry counts attempts that completed within upper_seconds, so counts never decrease along the list and there is no +Inf entry (use requests for the total).

Array<object>
object
count

Count is the number of attempts that completed within UpperSeconds.

integer
upper_seconds

UpperSeconds is the inclusive upper bound of this bucket.

number
outcomes

Outcomes counts attempts by outcome; the key set is fixed and always complete.

object
key
additional properties
integer format: int64
requests

Requests counts every signing attempt, including those slower than the largest latency bucket.

integer
timestamp
string
Example
{
"status": "ready"
}

Unauthorized

Media type application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object
error
string
error_description
string
Example
{
"error": "Unauthorized",
"error_description": "Invalid token"
}

Service Unavailable

Media type application/json

Signing backend state (ready, not_supported, uninitialized, sealed, denied, unreachable, timeout, canceled, association_mismatch, unavailable) with process-lifetime Transit signing telemetry. Only ready and not_supported return HTTP 200.

object
status
string
Allowed values: ready not_supported uninitialized sealed denied unreachable timeout canceled association_mismatch unavailable
telemetry
object
duration_seconds

DurationSeconds is the total time spent in signing attempts.

number
failures

Failures counts every attempt whose outcome is not success.

integer
latency_buckets

LatencyBuckets are cumulative: each entry counts attempts that completed within upper_seconds, so counts never decrease along the list and there is no +Inf entry (use requests for the total).

Array<object>
object
count

Count is the number of attempts that completed within UpperSeconds.

integer
upper_seconds

UpperSeconds is the inclusive upper bound of this bucket.

number
outcomes

Outcomes counts attempts by outcome; the key set is fixed and always complete.

object
key
additional properties
integer format: int64
requests

Requests counts every signing attempt, including those slower than the largest latency bucket.

integer
timestamp
string
Example
{
"status": "ready"
}