Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

Edit Variables

View as Markdown
  • PATCH
  • /workspaces
  • /:workspace
  • /variables
  • /:variable_id

Edits an environment variable

Request

REQUIRED SCOPES
VARIABLE_WRITE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

variable_idrequiredinteger
The ID of the variable

Example: 123

BODY PARAMETERS
keyrequiredstring
The name of the variable
valuestring
The value of the variable
settableboolean
If set to true the variable value can be set by Buddy actions
run_only_settableboolean
Available only if type=VAR. Requires settable=true. If set to true the variable value can be set by Buddy actions only for execution time
encryptedboolean
If set to true the variable value will be encrypted and hidden
init_pathstring
Initial path for the variable
defaultsstring
Default value for the variable
file_pathstring
Specifies where to copy the file on each run. Required if file_place is CONTAINER, and must start with / or ~
file_chmodstring
File permission set on copy to a container on each run. Required if file_place is CONTAINER
file_placestring enum
Required if type is FILE, SSH_KEY, SSH_PUBLIC_KEY, IOS_KEYCHAIN, or IOS_PROVISION_PROFILES, unless the variable is sandbox-scoped. If it's NONE, the variable can be used as a parameter in an action. For CONTAINER, the given key is additionally copied to an action container on each run and both file_path and file_chmod are required
Allowed enum:
NONE,
CONTAINER
passwordstring
Password for certificates
passphrasestring
Passphrase for encrypted SSH keys
key_identifierstring
Key identifier for iOS certificates, provisioning profiles, or GPG keys
disabledboolean
Set to true to disable the variable. Disabled variables are not injected anywhere
pipelines_access_levelstring enum
Default access level for pipelines when no rule in allowedPipelines matches. Default: USE_ONLY. Only valid for workspace- and project-scoped variables.
Allowed enum:
DENIED,
READ_ONLY,
USE_ONLY,
BLIND,
RUN_ONLY,
READ_WRITE,
MANAGE,
DEFAULT,
ALLOWED,
STAGE,
COMMIT
sandboxes_access_levelstring enum
Default access level for sandboxes when no rule in allowedSandboxes matches. Default: DENIED. Only valid for workspace- and project-scoped variables.
Allowed enum:
DENIED,
READ_ONLY,
USE_ONLY,
BLIND,
RUN_ONLY,
READ_WRITE,
MANAGE,
DEFAULT,
ALLOWED,
STAGE,
COMMIT
allowed_pipelinesAllowedPipelineView[]
Rules that allow or deny access to this variable from specific pipelines or actions. Send an empty array to clear all rules.
allowed_sandboxesAllowedSandboxView[]
Rules that allow or deny access to this variable from specific sandboxes. Send an empty array to clear all rules.
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource

Response

RESPONSE BODY
typestring enum
The type of the added variable. Defaults to VAR when not set
Allowed enum:
VAR,
FILE,
SSH_KEY,
IOS_KEYCHAIN,
IOS_PROVISION_PROFILES,
SSH_PUBLIC_KEY,
GPG_KEY
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
idinteger
The ID of the variable
keyrequiredstring
The name of the variable
valuestring
The value of the variable
encryptedboolean
If set to true the variable value will be encrypted and hidden
settableboolean
If set to true the variable value can be set by Buddy actions
projectProjectView
pipelineShortPipelineView
Short representation of a pipeline
actionActionIdView
Action reference
sandboxSandboxIdView
Sandbox reference
environmentEnvironmentIdView
Environment reference
run_only_settableboolean
Available only if type=VAR. Requires settable=true. If set to true the variable value can be set by Buddy actions only for execution time
init_pathstring
Initial path for the variable
defaultsstring
Default value for the variable
file_pathstring
Specifies where to copy the file on each run. Required if file_place is CONTAINER, and must start with / or ~
file_chmodstring
File permission set on copy to a container on each run. Required if file_place is CONTAINER
file_placestring enum
Required if type is FILE, SSH_KEY, SSH_PUBLIC_KEY, IOS_KEYCHAIN, or IOS_PROVISION_PROFILES, unless the variable is sandbox-scoped. If it's NONE, the variable can be used as a parameter in an action. For CONTAINER, the given key is additionally copied to an action container on each run and both file_path and file_chmod are required
Allowed enum:
NONE,
CONTAINER
binaryboolean
Whether the file is binary
public_valuestring
Public value for SSH key type variables
key_fingerprintstring
Fingerprint of SSH key
checksumstring
Checksum of the variable value
passwordstring
Password for certificates
passphrasestring
Passphrase for encrypted SSH keys
key_identifierstring
Key identifier for iOS certificates, provisioning profiles, or GPG keys
disabledboolean
Set to true to disable the variable. Disabled variables are not injected anywhere
pipelines_access_levelstring enum
Default access level for pipelines when no rule in allowedPipelines matches. Default: USE_ONLY. Only valid for workspace- and project-scoped variables.
Allowed enum:
DENIED,
READ_ONLY,
USE_ONLY,
BLIND,
RUN_ONLY,
READ_WRITE,
MANAGE,
DEFAULT,
ALLOWED,
STAGE,
COMMIT
sandboxes_access_levelstring enum
Default access level for sandboxes when no rule in allowedSandboxes matches. Default: DENIED. Only valid for workspace- and project-scoped variables.
Allowed enum:
DENIED,
READ_ONLY,
USE_ONLY,
BLIND,
RUN_ONLY,
READ_WRITE,
MANAGE,
DEFAULT,
ALLOWED,
STAGE,
COMMIT
allowed_pipelinesAllowedPipelineView[]
Rules that allow or deny access to this variable from specific pipelines or actions. Send an empty array to clear all rules.
allowed_sandboxesAllowedSandboxView[]
Rules that allow or deny access to this variable from specific sandboxes. Send an empty array to clear all rules.
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource

Last modified on Apr 22, 2026

Previous pageGet VariablesNext pageDelete Variables

Request example

curl -X PATCH "https://api.buddy.works/workspaces/:workspace/variables/:variable_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "API_TOKEN_UPDATED",
  "value": "new-secret-token-value",
  "encrypted": true,
  "settable": true,
  "disabled": true,
  "note": "Updated API token for external service",
  "agent_note": "my_custom_field: note for agent"
}'