Skip to main content
POST
/
secrets
/
{id}
/
versions
/
{vid}
:disable
Disable secret version
curl --request POST \
  --url https://api.akua.dev/v1/secrets/{id}/versions/{vid}:disable \
  --header 'Authorization: Bearer <token>' \
  --header 'if-match: <if-match>'
{
  "id": "<string>",
  "secret_id": "<string>",
  "version_number": 123,
  "created_at": 1,
  "etag": "<string>",
  "comment": "<string>",
  "destroyed_at": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

​
akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

​
if-match
string
required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256
Example:

"42"

Path Parameters

​
id
string
required

Secret ID. Prefixed form sec_<id> is canonical.

Required string length: 1 - 54
Example:

"sec_j572abc123def456"

​
vid
string
required

SecretVersion ID. Prefixed form secv_<id> is canonical.

Required string length: 1 - 55
Example:

"secv_j572abc123def456"

Response

Secret version disabled

​
id
string
required
Required string length: 1 - 55
​
secret_id
string
required
Required string length: 1 - 54
​
version_number
integer
required
​
state
enum<string>
required
Available options:
enabled,
disabled,
destroyed
​
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
etag
string
required
​
comment
string
Maximum string length: 200
​
destroyed_at
integer

Unix timestamp (seconds)

Required range: x >= 0