Secrets

Update a secret

PATCH
/deployments/secrets/{id}

Update an existing secret's value or metadata

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Secret ID or name

Request Body

application/json

Updated secret configuration

description?string

Description is an optional human-readable description of the secret's purpose (max 500 characters)

Lengthlength <= 500
name?string

Name is the new unique identifier for the secret. Can contain alphanumeric characters, underscores, hyphens, forward slashes, and periods (1-100 characters)

Length1 <= length <= 100
project_id?string

ProjectID is ignored - the project is automatically determined from your authentication

value?string

Value is the new sensitive data to store securely. Updating this replaces the existing secret value.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/deployments/secrets/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "created_at": "string",  "created_by": "string",  "description": "string",  "id": "string",  "last_updated_by": "string",  "name": "string",  "object": "secret",  "updated_at": "string"}