Keys & Secrets API reference
Project keys, secrets, HYOK clusters and hosts, custody transitions and the signed audit ledger.
Vault
The project's vault status: its custody mode, its active key, and the last custody change.
Any project member can read it.
Returns the project's custody mode, its active key, and the last custody change that completed.
Keys
The project's key-encryption key (KEK) versions.
List and read them, and rotate to a new version, which re-wraps every data key under the new KEK.
Reading keys needs a project admin or auditor; rotating needs a project admin.
Returns the project's key-encryption key (KEK) versions.
Returns one of the project's keys.
Creates a new version of the project's platform KEK and re-wraps every data key under it.
Secrets
Store, read, update, move, rotate and delete secret values, addressed by a /-delimited path, and list a secret's versions.
The creator owns a secret and only the owner can change it; its visibility decides who else can list and reveal it.
Revealing takes a single-use challenge, and every reveal is recorded in the audit ledger.
Returns a page of the secrets the caller owns or that are shared with them, in path order, without their values.
Creates a secret at
pathfrom a base64 value, with a visibility and optional metadata.Returns a secret's value, base64.
Returns a secret's value, base64.
Stores a new value for a secret as its next version.
Creates a secret at
pathfrom a base64 value, with a visibility and optional metadata.Creates a secret at
pathfrom a base64 value, with a visibility and optional metadata.Creates a secret at
pathfrom a base64 value, with a visibility and optional metadata.Revokes a secret at once: it can no longer be read or revealed.
HYOK Clusters & Hosts
Register the KMIP managers in your organisation and group them into clusters, which a project can attach to for hold-your-own-key custody.
These are organisation resources and need an organisation admin.
Returns the project's HYOK attachment for a region: the cluster it uses, the HSM model, and the key's KMIP id (
keyUid).Groups registered hosts into a cluster.
Returns the organisation's HYOK clusters.
Returns one HYOK cluster.
Renames a cluster, moves it to another region or replaces its hosts.
Deletes a cluster and its host memberships.
Registers a KMIP endpoint and the certificate references kibo uses to reach it.
Returns the organisation's HYOK hosts, newest first.
Returns one HYOK host.
Changes a host's label, endpoint or certificate references.
Deregisters a host.
Custody & Exit
Change a project's custody mode, read what your key's trust policy must name, and read the signed attestations that a project's keys were destroyed on exit.
Changing mode re-wraps every data key under the new KEK without decrypting the values.
Returns the values your key's trust policy must name before kibo can use the key: the AWS principal kibo calls from and the external id it sends, and the issuer and subject of the identity kibo fed…
Changes the project's custody mode.
Returns a custody transition job's state.
Returns the signed receipts recording that the project's keys were destroyed.
Returns one signed receipt recording that a project key was destroyed.
Audit Ledger
Download the signed, hash-chained ledger of every key and custody change, have it verified server-side, and fetch the public keys that verify its signature.
Signing keys need no authentication, so anyone can check a signature.
Returns the project's ledger events in sequence order, optionally limited to the range
fromtoto.Checks the project's ledger on the server: the hash chain and every signature.
Returns the public keys that verify ledger signatures and exit attestations: the active key and the earlier ones, so an old signature still verifies.