Skip to main content
PUT
/
api
/
secrets
/
{key}
Update secret
curl --request PUT \
  --url https://api.example.com/api/secrets/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "isActive": true,
  "isReserved": true,
  "expiresAt": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "message": "Secret STRIPE_API_KEY has been updated successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
key
string
required

Secret key identifier

Body

application/json
​
value
string

New secret value (will be encrypted)

​
isActive
boolean

Whether the secret is active

​
isReserved
boolean

Whether the secret is protected from deletion

​
expiresAt
string<date-time> | null

Expiration date (null to remove expiration)

Response

Secret updated successfully

​
success
boolean
​
message
string