Skip to main content
PUT
Replace a secret's stored body

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id
string
required

Workspace identifier (version 7 universally unique identifier, or UUID).

name
string
required

The name the secret is stored under.

Body

application/json

PUT /v1/workspaces/{workspace_id}/secrets/{secret_name} — replace the body.

data
object
required

Complete replacement JSON object. Fields omitted from this object are removed from the secret.

Response

OK

What a create and a replace both answer with.

One shape for both verbs because both say the same thing — which name now holds a secret — and the status code is what distinguishes them.

name
string
required

The name the secret is stored under.