Workflow secrets and variables

Set a secret or variable

Changed on

Creates a secret or variable, or rotates its value if it already exists at that place. Safe to call repeatedly.

  • The place is exactly one of path (a folder, / for the whole organization) or workflow (one workflow).
  • Writing a name that already exists at that place replaces its value; workflows referencing it pick the new value up on their next run.
  • The name and the secret flag are immutable: to change them, delete the entry and recreate it.
post/workflows/config

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/config
  • Auth
    HTTP bearer

Request body

namestring required

Entry name (^[A-Za-z_][A-Za-z0-9_]{0,127}$), referenced as secrets.NAME or vars.NAME.

valuestring required

The value. Never returned again if secret is true.

secretboolean required

Write-only secret (true) or readable variable (false).

pathstring

Folder place. Mutually exclusive with workflow.

workflowstring

Workflow reference (wf_... id or key). Mutually exclusive with path.

Example request

{
  "name": "JIRA_TOKEN",
  "secret": true,
  "path": "/action-items"
}

Response

The entry already existed; its value was rotated.

idstring required
namestring required

Referenced in definitions as ${{ secrets.NAME }} or ${{ vars.NAME }}.

secretboolean required

Immutable. true makes the value write-only and redacted everywhere.

pathstring

Folder place (/ is the organization root). Present when the entry lives on a folder.

workflowstring

Workflow reference. Present when the entry lives on one workflow.

valuestring nullable

Only returned for non-secret entries.

effectiveboolean

Only with ancestors=true: whether this row wins precedence for its name.

mode'created' | 'updated'

Write responses only: whether the entry was created or its value rotated.

createdBystring
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "cfg_2b9d1f0a",
  "name": "NP_API_KEY",
  "path": "/action-items"
}

Changes