Skip to content

`PUT /api/v1/secrets/{name}` — update a secret.

PUT
/api/v1/secrets/{name}
curl --request PUT \
--url https://example.com/api/v1/secrets/example \
--header 'Content-Type: application/json' \
--data '{ "description": "example", "expires_at": "example", "value": "example" }'
name
required
string

Secret name

Media type application/json

Request body for PUT /api/v1/secrets/{name}.

object
description

New description (optional).

string | null
expires_at

New expiry date. Absent = don’t change; null = clear; string = set. Uses Value instead of Option<Option<String>> to satisfy clippy’s option_option lint while still distinguishing absent from null.

value

New value (optional).

string | null
Example generated
{
"description": "example",
"expires_at": "example",
"value": "example"
}

Secret updated

Media type application/json

Response body for a single secret (never includes value).

object
created_at
required
string
created_by
required
string
description
string | null
expires_at
string | null
name
required
string
restriction
updated_at
required
string
updated_by
required
string
Example generated
{
"created_at": "example",
"created_by": "example",
"description": "example",
"expires_at": "example",
"name": "example",
"restriction": "example",
"updated_at": "example",
"updated_by": "example"
}

Invalid request body

Secret not found