Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | …/keys/{key}/key_versions/{key_version}; the id is the version number, from 1. |
uid | string | kmv_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
state | KeyVersionState | The version's lifecycle state. Output only. One of pending, enabled, retired, destroy_scheduled, destroyed. |
algorithm | KeyAlgorithm | The 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_pem | string | The public key in PEM (SubjectPublicKeyInfo), for asymmetric keys; empty otherwise. Output only. |
destroy_time | timestamp | When 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a key version. |
GET | list | Lists a key's versions. |
POST | destroy | Schedules 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