Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Environment API

Get all environments in the workspace

get/workspaces/{workspace_domain}/environments

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Query parameters

project_namestring
Example:my-project

Project name to filter environments

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

namestring

The name of the environment

identifierstring

The human-readable identifier of the environment

idinteger

The ID of the environment

scope'PROJECT' | 'WORKSPACE' | 'ANY'

The scope level of the environment

Example response

{
  "name": "staging",
  "identifier": "my-staging",
  "scope": "PROJECT"
}