Get

  • GET
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /environments
  • /:environment_id

Returns the details of a single environment.

Request

REQUIRED SCOPES
WORKSPACE, ENVIRONMENT_INFO
URL PARAMETERS
workspacerequired string
The workspace domain.
project_namerequired string
The name ID of the project.
environment_idrequired string
The unique string ID of the desired environment.

Last modified on Mar 3, 2025

Example:

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/projects/:project_name/environments/:environment_id" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "Content-Type: application/json"
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/environments/xo4pbVrE", "html_url": "https://app.buddy.works/buddy/company-website/environments/environment/xo4pbVrE", "id": "xo4pbVrE", "name": "Staging environment", "identifier": "stage_env", "type": "STAGE", "tags": [ "tag1", "staging" ], "public_url": "http://staging.com", "all_pipelines_allowed": false, "allowed_pipelines": [ { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/524069", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/524069", "id": 524069, "name": "pipeline1" } ], "project": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website", "html_url": "https://app.buddy.works/buddy/company-website", "name": "my-environment", "display_name": "my-environment", "status": "ACTIVE" }, "variables": [ { "id": 1912258, "key": "myVar2", "value": "myValue2", "type": "VAR", "settable": true, "description": "some variable2" }, { "id": 1912257, "key": "myVar1", "value": "myValue1", "type": "VAR", "settable": true, "description": "some variable1" } ], "permissions": { "others": "DENIED", "users": [ { "id": 1, "access_level": "MANAGE" } ], "groups": [ { "id": 422, "access_level": "USE_ONLY" } ] } }
STATUS
200 OK
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999