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

Request

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

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "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.