---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Disable a secret version"
description: "`secrets.secret_versions.disable` (POST /v1/{name}:disable): Disables a secret version: bindings stop delivering it."
type: reference
product: platform
summary: "Disables a secret version: bindings stop delivering it."
updated: 2026-09-28
nav: false
---

> **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.

Disables a secret version: bindings stop delivering it.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:disable`
- **Scope** `secrets:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [secret_versions](/docs/api/secret_versions)
- **Validate-only** `validate_only=true` runs every check and writes nothing

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the secret version to disable. Required. |
| `etag` | `string` | Disable only if the current etag matches. |
| `validate_only` | `bool` | Validate without changing anything. |

## Response

| 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. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:disable" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.secrets.secretVersions.disable({ name: 'orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version' })
```

**Rust**

```rust
let mut req = sylphx::secrets::DisableSecretVersionRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version".to_string();
let response = sx.secrets().secret_versions().disable(req).await?;
```

**CLI**

```bash
sylphx secrets secret-versions disable orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version
```

**MCP**

```json
{ "method_id": "secrets.secret_versions.disable", "args": {"name":"orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version"} }
```