Keys
A Key is a non-exportable key on the regional signer: a handle for signing, encryption, or MAC.
A Key is a non-exportable key on the regional signer: a handle for signing, encryption, or MAC. Rotation adds a version and keeps the old one usable for verification and decryption until it is destroyed.
Service Sylphx Keys · Resource type keys.sylphx.com/Key · Name pattern orgs/{org}/projects/{project}/envs/{env}/keys/{key} · Shape spec_status
Fields
| 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. |
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. |
GET | list | Lists keys in an environment. |
POST | create | Creates a key; the signer generates its first version. |
PATCH | update | Updates a key's rotation period, deletion protection, or metadata. |
DELETE | delete | Deletes a key and schedules every version's destruction. |
POST | rotate | Rotates a key: adds a version and makes it primary. Older versions keep verifying and decrypting until destroyed. |
POST | sign | Signs data or a digest with a SIGN key. Every use is audited. |
POST | verify | Verifies a signature made by a SIGN key. |
POST | encrypt | Encrypts data with an ENCRYPT key. |
POST | decrypt | Decrypts a ciphertext made by Encrypt with this key. |
POST | mac_sign | Computes a MAC of data with a MAC key. |
POST | mac_verify | Verifies a MAC made by a MAC key, in constant time. |
get
Gets a key.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key · scope keys:read · effect read · Request, response and examples
list
Lists keys in an environment.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys · scope keys:read · effect read · paginated · Request, response and examples
create
Creates a key; the signer generates its first version.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys · scope keys:write · effect write · long-running · Request, response and examples
update
Updates a key's rotation period, deletion protection, or metadata.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key · scope keys:write · effect write · long-running · Request, response and examples
delete
Deletes a key and schedules every version's destruction.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key · scope keys:write · effect destructive · long-running · Request, response and examples
rotate
Rotates a key: adds a version and makes it primary. Older versions keep verifying and decrypting until destroyed.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:rotate · scope keys:write · effect write · validate_only · long-running · Request, response and examples
sign
Signs data or a digest with a SIGN key. Every use is audited.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:sign · scope keys:sign · effect read · Request, response and examples
verify
Verifies a signature made by a SIGN key.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:verify · scope keys:verify · effect read · Request, response and examples
encrypt
Encrypts data with an ENCRYPT key.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:encrypt · scope keys:encrypt · effect read · Request, response and examples
decrypt
Decrypts a ciphertext made by Encrypt with this key.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:decrypt · scope keys:decrypt · effect read · Request, response and examples
mac_sign
Computes a MAC of data with a MAC key.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:macSign · scope keys:sign · effect read · Request, response and examples
mac_verify
Verifies a MAC made by a MAC key, in constant time.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/keys/key:macVerify · scope keys:verify · effect read · Request, response and examples