Skip to main content

Create or update workspace secret

Create a new secret or update an existing one by name. The full value is never included in API responses.

POST/api/workspace-secrets
HTTP referenceScope secrets:writeUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Authentication: use a scoped developer API key or a valid session token.

Secret names must start with a letter, contain only letters, numbers, and underscores, and be at most 64 characters. Names are trimmed and normalized to lowercase. Values are trimmed and must contain at least three characters afterward. Unknown request fields are rejected with 422.

If a secret with the same name already exists, its value is updated in place.

Once stored, reference the secret in HTTP Request columns with {{secrets.name}} in URL paths/query, headers, or body templates. Requests using secrets require a literal HTTPS origin; secrets cannot be placed in the host.

Body parameters

  • namerequired

    string

    Secret name. Must start with a letter, only letters/numbers/underscores, max 64 chars.

  • valuerequired

    string

    Secret value (API key, token, etc). Min 3 characters.

Errors

StatusMeaning
422Invalid request, name, or value.
400Missing authenticated user email, user ID, or organization context.
401Missing or invalid authentication.
403Access denied.

Docs