Skip to content
Console
On this page

Key versions

A KeyVersion is one generation of a Key's material.

A KeyVersion is one generation of a Key's material. Its private or symmetric material never leaves the signer; an asymmetric version publishes its public key.

Service Sylphx Keys · Resource type keys.sylphx.com/KeyVersion · Name pattern orgs/{org}/projects/{project}/envs/{env}/keys/{key}/key_versions/{key_version} · Shape record

Fields

FieldTypeWhat it is
namestring…/keys/{key}/key_versions/{key_version}; the id is the version number, from 1.
uidstringkmv_<cell><ulid>. Output only.
metaResourceMetaResource metadata. Output only.
stateKeyVersionStateThe version's lifecycle state. Output only. One of pending, enabled, retired, destroy_scheduled, destroyed.
algorithmKeyAlgorithmThe algorithm, equal to the key's. Output only. One of ed25519, ec_p256_sha256, rsa_pkcs1_2048_sha256, rsa_pss_3072_sha256, aes_256_gcm, hmac_sha256.
public_key_pemstringThe public key in PEM (SubjectPublicKeyInfo), for asymmetric keys; empty otherwise. Output only.
destroy_timetimestampWhen the version's material is destroyed, or was. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a key version.
GETlistLists a key's versions.
POSTdestroySchedules a key version's destruction after a 24-hour grace; the primary version cannot be destroyed.

get

Gets a key version.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key/key_versions/key-version · scope keys:read · effect read · Request, response and examples

list

Lists a key's versions.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key/key_versions · scope keys:read · effect read · paginated · Request, response and examples

destroy

Schedules a key version's destruction after a 24-hour grace; the primary version cannot be destroyed.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key/key_versions/key-version:destroy · scope keys:write · effect destructive · validate_only · Request, response and examples