Environments

List environments available for a project.

get/{spaceId}/projects/{projectId}/environments

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/projects/{projectId}/environments
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

The ID of the space containing the resource(s).

projectIdstring required

The ID of the project.

Query parameters

partialNamestring

Filters the environments by partial name fragment.

skipinteger required

Number of items to skip. Defaults to zero

takeinteger required

Number of items to take. Defaults to 30

typestring[]

Filters environments by EnvironmentType.

Response

Success

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastPageNumberinteger
NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Id": "Environments-1",
      "SpaceId": "Spaces-1"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "BaseEnvironmentV2",
  "LastPageNumber": 1,
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

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