Edit Environments
- PATCH
- /workspaces
- /:workspace
- /environments
- /:environment_id
Update environment configuration
Examples
Example: Update environment
curl -X PATCH "https://api.buddy.works/workspaces/:workspace/environments/:environment_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Production Environment",
"identifier": "prod-env-v2",
"tags": [
"production",
"stable",
"updated"
],
"icon": "production-v2.svg",
"public_url": "https://prod-v2.example.com",
"pipelines_access_level": "DENIED",
"environments_access_level": "DENIED",
"note": "Notes about this resource",
"agent_note": "my_custom_field: note for agent"
}'Example: Update environment name only
curl -X PATCH "https://api.buddy.works/workspaces/:workspace/environments/:environment_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Renamed Environment"
}'EXAMPLE RESPONSE
{
"url": "https://api.buddy.works/workspaces/my-workspace/projects/environments/3a4KbBQl",
"html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/3a4KbBQl",
"id": "3a4KbBQl",
"name": "Development Environment",
"identifier": "dev",
"tags": [
"development",
"dev"
],
"icon": "development.svg",
"public_url": "https://env.myproduct.com",
"pipelines_access_level": "DENIED",
"environments_access_level": "DENIED",
"allowed_pipelines": [
{
"project": "my-project",
"pipeline": "Deploy to Dev"
}
],
"allowed_environments": [
{
"project": "my-project",
"environment": "staging"
}
],
"create_date": "2024-01-15T10:30:00Z",
"project": {
"url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project",
"html_url": "https://app.buddy.works/my-workspace/my-project",
"name": "my-project",
"display_name": "My Project"
},
"permissions": {
"others": "USE_ONLY",
"users": [
{
"id": 123,
"access_level": "MANAGE"
}
],
"groups": [
{
"id": 456,
"access_level": "READ_WRITE"
}
]
},
"base_environments": [
"production",
"staging"
],
"targets": [
{
"url": "https://api.buddy.works/workspaces/my-workspace/projects/my-project/targets/123",
"html_url": "https://app.buddy.works/my-workspace/my-project/environments/environment/3a4KbBQl/targets/abc123/edit",
"id": "abc123",
"identifier": "dev-server",
"type": "SSH"
}
],
"base_only": false,
"allow_decrypted_values": false,
"scope": "PROJECT",
"note": "Notes about this resource",
"agent_note": "my_custom_field: note for agent"
}STATUS
200 OK