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
On this page
Get a key version
Gets a key version.
Gets a key version.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key/key_versions/key-version - Scope
keys:read - Effect
read— nothing is written. - Collection key_versions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the key version to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key/key_versions/key-version" \
-H "Authorization: Bearer $SYLPHX_API_KEY"