v4

OpenAPI 3.1.0MIT2026-08-04193459793.6 KB
Secrets

Create a new secret

Create a new secret to store sensitive configuration values

post/deployments/secrets

Request body

descriptionstring

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

namestring required

Name is the 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 required

Value is the sensitive data to store securely (e.g., API keys, passwords, tokens). Encrypted at rest.

Response

Secret created 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