Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Secrets
A Secret is a named, versioned value that a third party accepts only as a bearer string.
A Secret is a named, versioned value that a third party accepts only as a bearer string. Its versions hold the values; its bindings deliver them.
Service Sylphx Secrets · Resource type secrets.sylphx.com/Secret · Name pattern orgs/{org}/projects/{project}/envs/{env}/secrets/{secret} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/secrets/{secret}. |
uid | string | sec_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | SecretSpec | Desired state. Required. |
status | SecretStatus | 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 secret. |
GET | list | Lists secrets in an environment. |
POST | create | Creates a secret, without a value; add one with CreateSecretVersion. |
PATCH | update | Updates a secret. |
DELETE | delete | Deletes a secret and destroys every version. |
#get
Gets a secret.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret · scope secrets:read · effect read · Request, response and examples
#list
Lists secrets in an environment.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets · scope secrets:read · effect read · paginated · Request, response and examples
#create
Creates a secret, without a value; add one with CreateSecretVersion.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets · scope secrets:write · effect write · Request, response and examples
#update
Updates a secret.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret · scope secrets:write · effect write · Request, response and examples
#delete
Deletes a secret and destroys every version.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret · scope secrets:write · effect destructive · Request, response and examples