On this page
Destroy a secret version
Destroys a secret version's value irrecoverably.
Destroys a secret version's value irrecoverably.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:destroy - Scope
secrets:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection secret_versions
- Validate-only
validate_only=trueruns every check and writes nothing
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the secret version to destroy. Required. |
etag | string | Destroy 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— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/secrets/secret/secret_versions/secret-version:destroy" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'