Skip to content

Rotate or re-describe a secret​

PATCH
/v1/secrets/{id}

Send value to rotate in place (bumps version; every referencing configuration picks the new value up on its next use, with nothing to re-edit). name and description may also be changed — but a RENAME is refused with 409 while any destination still references the old name, since the rename would break every ${secret.OLD} already in a config. Requires the admin scope.

Authorizations​

apiKey

Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
string
Required

Request Body​

application/json
JSON
{
  
"value": "string",
  
"name": "slack_token",
  
"description": "string"
}

Responses​

Updated.

application/json
JSON
{
  
"id": "sec_01JX9",
  
"name": "slack_token",
  
"description": "Slack incoming-webhook token",
  
"version": 1,
  
"created_at": "string",
  
"updated_at": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Emithook · a Finnoto product