---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Secret versions"
description: "The `secret_versions` collection of Sylphx Secrets: A SecretVersion is one immutable value of a Secret."
type: reference
product: platform
summary: "A SecretVersion is one immutable value of a Secret."
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `…/secrets/{secret}/secret_versions/{secret_version}`; the id is the version number, from 1. |
| `uid` | `string` | `scv_<cell><ulid>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `payload` | `bytes` | The value, at most 64 KiB. Write-only. Required. Never returned again. |
| `state` | `SecretVersionState` | The version's lifecycle state. Output only. One of `enabled`, `disabled`, `destroyed`. |
| `destroy_time` | `timestamp` | When 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/secret_versions#get) | Gets a secret version. |
| `GET` | [`list`](/docs/api/secret_versions#list) | Lists a secret's versions. |
| `POST` | [`create`](/docs/api/secret_versions#create) | Adds a value to a secret as its newest version. The value is never returned. |
| `POST` | [`disable`](/docs/api/secret_versions#disable) | Disables a secret version: bindings stop delivering it. |
| `POST` | [`enable`](/docs/api/secret_versions#enable) | Enables a disabled secret version. |
| `POST` | [`destroy`](/docs/api/secret_versions#destroy) | Destroys a secret version's value irrecoverably. |
| `POST` | [`access`](/docs/api/secret_versions#access) | Reads 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](/docs/api/secret_versions/get)

## 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](/docs/api/secret_versions/list)

## 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](/docs/api/secret_versions/create)

## 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](/docs/api/secret_versions/disable)

## 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](/docs/api/secret_versions/enable)

## 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](/docs/api/secret_versions/destroy)

## 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](/docs/api/secret_versions/access)