Runbooks

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

get/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/environments/v2

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/runbooks/{id}/environments/v2
  • 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

spaceIdentifierstring required

Identifier (ID or slug) of the space

projectIdstring required

The ID of the project containing this resource. Will be inferred if not provided.

gitRefstring required

ID of the Runbook

idstring required

Response

The requested list of Runbook Environments

Example response

{
  "Environments": [
    {
      "Id": "Environments-1",
      "SpaceId": "Spaces-1"
    }
  ]
}

Changes

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