---
title: "Get a list of environments a Runbook can be run within, based on its EnvironmentScope."
method: GET
path: "/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/environments"
tags: ["Runbooks"]
---

# Get a list of environments a Runbook can be run within, based on its EnvironmentScope.

`GET /spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/environments`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/{id}/environments`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

## Path parameters

- `spaceIdentifier` string, required
- `projectId` string, required
- `id` string, required

## Response `200`

The requested list of Runbook Environments

- EnvironmentResource[]
  - `AllowDynamicInfrastructure` boolean: If set to true, deployments to this environment will be allowed to contain steps that manage infrastructure. This relies on DeploymentActionResource being set to allow managing resource for a step
  - `Description` string: Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
  - `EnvironmentTags` string[]: List of tags assigned to this environment
  - `ExtensionSettings` ExtensionSettingsValues[]: Not intended for general use; You should not alter or add/remove any values it may have.
    - `ExtensionId` string
    - `Values` unknown
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
  - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `Name` string: Gets or sets the name of this environment. This should be short, preferably 5-20 characters.
  - `Slug` string
  - `SortOrder` integer: Gets or sets a number indicating the priority of this environment in sort order. Environments with a lower sort order will appear in the UI before items with a higher sort order.
  - `SpaceId` string
  - `UseGuidedFailure` boolean: If set to true, deployments will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.

## Other responses

- `400`: Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404`: Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)