Skip to main content
GET
Get a credential's rotation status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

credential_id
string<uuid4>
required

Response

Rotation status resolved

Where a credential's latest recorded rotation has got to in every linked cluster. Carries no secret material.

rotation_id
string<uuid> | null
required

Null when no rotation of the credential was recorded.

revision
integer
required

The credential's secret revision.

rotated_at
string<date-time> | null
required
verified_at
string<date-time> | null
required

When the old value was last confirmed out of use; null while it is not safe to revoke.

safe_to_revoke
boolean
required

True when every running cluster whose copy Ankra renders serves the new value and no cluster is not_covered. A not_covered cluster blocks it, because the rotation does not rewrite that cluster's copy: it is listed in blocking_clusters with the command that updates the copy by hand. waiting_for_start and platform_only clusters do not block it and are still listed in clusters.

blocking_clusters
CredentialRotationBlockingCluster · object[]
required
clusters
CredentialRotationClusterPropagation · object[]
required