Skip to content

Get keyring status

GET
/api/v1/keyring/status

Returns known key versions and encrypted datasource envelope counts without key material. ADMIN is required.

Keyring status returned

object
converged
boolean
currentVersion
string
envelopes
Array<object>
object
count
integer format: int64
keyVersion
string
known
boolean
knownVersions
Array<string>
unique items
reencryptionRequired
integer format: int64
unknownVersionCount
integer format: int64

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference