Sign in
Secrets

Update a secret

Update an existing secret's value or metadata

patch/deployments/secrets/{id}

Path parameters

idstring required

Secret ID or name

Request body

descriptionstring

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

namestring

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

project_idstring

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

valuestring

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

Response

Secret updated successfully

created_atstring

CreatedAt is the ISO8601 timestamp when this secret was created

created_bystring

CreatedBy is the identifier of who created this secret.

descriptionstring

Description is a human-readable description of the secret's purpose

idstring

ID is the unique identifier for this secret

last_updated_bystring

LastUpdatedBy is the identifier of who last updated this secret.

namestring

Name is the name/key of the secret

object'secret'

The object type, which is always secret.

updated_atstring

UpdatedAt is the ISO8601 timestamp when this secret was last updated

Changes

No recorded changes to this endpoint across all 14 revisions of this API.