Environments

Get a list of Environments.

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

get/environments/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/environments/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

idsstring[]

Environment Ids to filter results to only Environments with the given Ids

namestring

Filters the returned environments by the specified name fragment. Left for backwards compatibility; prefer PartialName.

partialNamestring

Filters the documents using the specified partialName fragment

skipinteger

Number of items to skip. Defaults to zero

takeinteger

Number of items to take. Defaults to 10

Response

The requested list of Environments

Example response

{
  "Environments": {
    "Items": [
      {
        "ExtensionSettings": [],
        "Links": {
          "Self": "/api/..."
        },
        "SpaceId": "Spaces-1"
      }
    ],
    "ItemsPerPage": 30,
    "ItemType": "Environment",
    "LastPageNumber": 1,
    "Links": {
      "Self": "/api/..."
    },
    "NumberOfPages": 2,
    "TotalResults": 42
  }
}

Changes

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