Environments

Get a list of Environments

Lists the name and ID of all of the environments in the supplied Space. The results will be sorted by the SortOrder field on each environment.

get/environments/all/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/environments/all/v1
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Query parameters

channelIdstring

A Channel Id used to filter a query.

idsstring[]

A comma separated list of Deployment Environment resource ids used to filter a query.

projectIdstring

A project Id used to filter a query.

Response

Requested list of Environments

Example response

{
  "Environments": [
    {
      "ExtensionSettings": [],
      "Links": {
        "Self": "/api/..."
      },
      "SpaceId": "Spaces-1"
    }
  ]
}

Changes

No recorded changes to this operation across all 13 revisions of this API.