v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Organization Secrets

Update Secret

Update an existing secret in organization vault.

Security:

  • Replaces existing encrypted value with new encrypted value
  • Old value is permanently overwritten
  • No history or audit trail of previous values

Use Cases:

  • Rotate API keys periodically
  • Update expired tokens
  • Change credentials after security incident
put/v1/organizations/secrets/{secret_name}

Path parameters

secret_namestring required

Request body

secret_valuestring required

REQUIRED. New plaintext value for the secret. This will replace the existing encrypted value. The old value is permanently overwritten with no history. The new value will be encrypted at rest using Fernet encryption. Use this to rotate keys, update expired tokens, or change credentials. Format: any string (will be encrypted as-is).

Example request

{
  "description": "Rotate Stripe API key",
  "secret_value": "YOUR_STRIPE_API_KEY"
}

Response

Successful Response

secret_namestring required

Name of the secret that was operated on. This is the same name provided in the request. Use this name to reference the secret in api_call stage configuration.

createdboolean nullable

True if this secret was created, null otherwise. Only set for POST /secrets operations.

updatedboolean nullable

True if this secret was updated, null otherwise. Only set for PUT /secrets/{name} operations.

deletedboolean nullable

True if this secret was deleted, null otherwise. Only set for DELETE /secrets/{name} operations.

Example response

{
  "created": true,
  "description": "Secret created successfully",
  "secret_name": "stripe_api_key"
}