Runbooks

Get a list of Runbooks for a Project

get/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/all/v2

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/projects/{projectId}/runbooks/all/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 the resource(s).

Query parameters

idsstring[]

A list of Runbook resource ids used to filter a query.

Response

Requested list of Runbooks

Example response

{
  "Runbooks": [
    {
      "Environments": [
        "Environments-1",
        "..."
      ],
      "Links": {
        "Self": "/api/..."
      },
      "ProjectId": "Projects-1",
      "SpaceId": "Spaces-1"
    }
  ]
}

Changes

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