API keys
An ApiKey is a credential of one environment, a project CI credential, or an org-wide key (it acts on every project of the org), issued only…
An ApiKey is a credential of one environment, a project CI credential, or an org-wide key (it acts on every project of the org), issued only by Access (the platform has one key system). The secret is returned once, by Create and Roll, and never again.
Service Sylphx Access · Resource type access.sylphx.com/ApiKey · Name pattern orgs/{org}/projects/{project}/envs/{env}/api_keys/{api_key} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/api_keys/{api_key}, or orgs/{org}/api_keys/{api_key} for an org-wide key. |
uid | string | key_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ApiKeySpec | Desired state. Required. |
status | ApiKeyStatus | 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 an API key. |
GET | list | Lists API keys in an environment, project, or org. |
POST | create | Creates an API key. Access assigns the id. |
PATCH | update | Updates an API key. |
DELETE | delete | Deletes an API key. |
POST | revoke | Revokes an API key immediately; revocation propagates on its own fast path, ahead of the bulk key data. |
POST | roll | Rolls an API key: returns a new key with the same spec and revokes the old one after the grace period. |
get
Gets an API key.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key · scope access:read · effect read · Request, response and examples
list
Lists API keys in an environment, project, or org.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys · scope access:read · effect read · paginated · Request, response and examples
create
Creates an API key. Access assigns the id.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys · scope access:keys:write · effect write · Request, response and examples
update
Updates an API key.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key · scope access:keys:write · effect write · Request, response and examples
delete
Deletes an API key.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key · scope access:keys:write · effect destructive · Request, response and examples
revoke
Revokes an API key immediately; revocation propagates on its own fast path, ahead of the bulk key data.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key:revoke · scope access:keys:write · effect destructive · Request, response and examples
roll
Rolls an API key: returns a new key with the same spec and revokes the old one after the grace period.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/api_keys/api-key:roll · scope access:keys:write · effect write · Request, response and examples