---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Secrets"
description: "The `secrets` collection of Sylphx Secrets: A Secret is a named, versioned value that a third party accepts only as a bearer string."
type: reference
product: platform
summary: "A Secret is a named, versioned value that a third party accepts only as a bearer string."
updated: 2026-09-28
order: 900
---

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`](/docs/api/secrets#get) | Gets a secret. |
| `GET` | [`list`](/docs/api/secrets#list) | Lists secrets in an environment. |
| `POST` | [`create`](/docs/api/secrets#create) | Creates a secret, without a value; add one with CreateSecretVersion. |
| `PATCH` | [`update`](/docs/api/secrets#update) | Updates a secret. |
| `DELETE` | [`delete`](/docs/api/secrets#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](/docs/api/secrets/get)

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

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

## 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](/docs/api/secrets/update)

## 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](/docs/api/secrets/delete)