Skip to content
Console
On this page

Secret versions

A SecretVersion is one immutable value of a Secret.

A SecretVersion is one immutable value of a Secret. The value is write-only: Create reads it, and no response carries it except AccessSecretVersion.

Service Sylphx Secrets · Resource type secrets.sylphx.com/SecretVersion · Name pattern orgs/{org}/projects/{project}/envs/{env}/secrets/{secret}/secret_versions/{secret_version} · Shape record

Fields

FieldTypeWhat it is
namestring…/secrets/{secret}/secret_versions/{secret_version}; the id is the version number, from 1.
uidstringscv_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
payloadbytesThe value, at most 64 KiB. Write-only. Required. Never returned again.
stateSecretVersionStateThe version's lifecycle state. Output only. One of enabled, disabled, destroyed.
destroy_timetimestampWhen the value was destroyed. 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.

MethodCallWhat it does
GETgetGets a secret version.
GETlistLists a secret's versions.
POSTcreateAdds a value to a secret as its newest version. The value is never returned.
POSTdisableDisables a secret version: bindings stop delivering it.
POSTenableEnables a disabled secret version.
POSTdestroyDestroys a secret version's value irrecoverably.
POSTaccessReads a secret version's value back. Break-glass: a separate permission, audited on every call, and never exposed to MCP.

get

Gets a secret version.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version · scope secrets:read · effect read · Request, response and examples

list

Lists a secret's versions.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions · scope secrets:read · effect read · paginated · Request, response and examples

create

Adds a value to a secret as its newest version. The value is never returned.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions · scope secrets:write · effect write · Request, response and examples

disable

Disables a secret version: bindings stop delivering it.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:disable · scope secrets:write · effect write · validate_only · Request, response and examples

enable

Enables a disabled secret version.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:enable · scope secrets:write · effect write · validate_only · Request, response and examples

destroy

Destroys a secret version's value irrecoverably.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:destroy · scope secrets:write · effect destructive · validate_only · Request, response and examples

access

Reads a secret version's value back. Break-glass: a separate permission, audited on every call, and never exposed to MCP.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:access · scope secrets:access · effect read · Request, response and examples