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
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a key
Gets a key.
Gets a key.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key - Scope
keys:read - Effect
read— nothing is written. - Collection keys
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the key to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/keys/{key}. |
uid | string | kms_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | KeySpec | Desired state. Required. |
status | KeyStatus | Observed state. 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. |
#KeySpec
| Field | Type | What it is |
|---|---|---|
purpose | KeyPurpose | What the key does. Required. One of sign, encrypt, mac. |
algorithm | KeyAlgorithm | The algorithm; it must suit the purpose. Required. One of ed25519, ec_p256_sha256, rsa_pkcs1_2048_sha256, rsa_pss_3072_sha256, aes_256_gcm, hmac_sha256. |
rotation_period | duration | Rotate automatically this often; unset means rotate only on request. |
deletion_protection | bool | While true, Delete fails with DELETION_PROTECTED. Default true. |
#KeyStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
primary_version | string | The version Sign, Encrypt, and MacSign use. Output only. |
origin | KeyOrigin | Where the key material came from. Output only. One of generated, imported. |
next_rotation_time | timestamp | When the next automatic rotation runs. Output only. |
regions | string[] | The regions whose signer holds the key. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#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" \
-H "Authorization: Bearer $SYLPHX_API_KEY"