Edit

PATCH
/workspaces
/:workspace
/environments
/:environment_id

Edits an environment in the workspace.

Request

REQUIRED SCOPES

ENVIRONMENT_MANAGE

URL PARAMETERS

workspacerequiredstring

The workspace name.

environment_idrequiredstring

The unique string ID of the desired environment.

POST PARAMETERS

namestring

The name of the environment.

identifierstring

Readable ID for environment. It can consist of lowercase letters, numbers, and underscores. It must start with a letter.

iconstring

The environment icon.

public_urlstring

The public URL for the environment.

tagsstring[]

A list of tags.

base_onlyboolean

If true, the environment can only be used as a base for other environments.

base_environmentsstring[]

Array of base environment identifiers that this environment inherits from.

variablesvariable[]

Define to set variables for the environment.

permissionspermission

Define to set permissions for the environment.

all_pipelines_allowedboolean

Defines whether all pipelines are allowed to use the environment.

allowed_pipelinesAllowedPipeline[]

List of pipelines that can use this environment.

all_environments_allowedboolean

Defines whether all environments can inherit this environment.

allowed_environmentsAllowedEnvironment[]

List of environments that can inherit this environment.

Last modified on Jan 20, 2026

List Delete

Request example


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/environments/:environment_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "identifier": "stage_env",
  "name": "Staging environment",
  "icon": "rocket",
  "tags": [
    "staging",
    "tag1"
  ],
  "public_url": "http://staging.com",
  "base_only": false,
  "variables": [
    {
      "key": "myVar1",
      "value": "myValue1",
      "type": "VAR",
      "settable": true,
      "encrypted": false,
      "description": "some variable1"
    }
  ],
  "permissions": {
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "MANAGE"
      }
    ],
    "groups": [
      {
        "id": 2,
        "access_level": "USE_ONLY"
      }
    ]
  },
  "all_pipelines_allowed": false,
  "allowed_pipelines": [
    {
      "project": "company-website",
      "pipeline": "deploy-prod"
    }
  ],
  "all_environments_allowed": false,
  "allowed_environments": [
    {
      "project": "company-website",
      "environment": "development"
    }
  ]
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/environments/9DBbgP4q",
  "html_url": "https://app.buddy.works/buddy/environments/environment/9DBbgP4q",
  "id": "9DBbgP4q",
  "name": "Staging environment",
  "identifier": "stage_env",
  "scope": "WORKSPACE",
  "icon": "rocket",
  "tags": [
    "staging",
    "tag1"
  ],
  "public_url": "http://staging.com",
  "base_only": false,
  "base_environments": [],
  "all_pipelines_allowed": false,
  "allowed_pipelines": [
    {
      "project": "company-website",
      "pipeline": "deploy-prod"
    }
  ],
  "all_environments_allowed": false,
  "allowed_environments": [
    {
      "project": "company-website",
      "environment": "development"
    }
  ],
  "variables": [
    {
      "id": 1,
      "key": "myVar1",
      "value": "myValue1",
      "type": "VAR",
      "settable": true,
      "run_only_settable": false,
      "description": "some variable1"
    }
  ],
  "permissions": {
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "MANAGE"
      }
    ],
    "groups": [
      {
        "id": 2,
        "access_level": "USE_ONLY"
      }
    ]
  }
}

STATUS
200 OK