Runbooks

Get a list of Runbook Run Previews for a Runbook

Gets a list of Runbook Run Previews that describes what steps will/won't be run during a Runbook Run on a given environment and tenant for a Runbook.

post/projects/{projectId}/{gitRef}/runbooks/{runbookId}/runbookRuns/previews

Request

Base URL
https://demo.octopus.app/api
URL
https://demo.octopus.app/api/projects/{projectId}/{gitRef}/runbooks/{runbookId}/runbookRuns/previews
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

projectIdstring required

ID of the Project

gitRefstring required

runbookIdstring required

ID of the Runbook

Request body

GitRefstring required

IncludeDisabledStepsboolean

Boolean to include/exclude disabled steps from response

ProjectIdstring required

ID of the Project

RunbookIdstring required

ID of the Runbook

SpaceIdstring required

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

Example request

{
  "DeploymentPreviews": [
    {
      "EnvironmentId": "Environments-1",
      "TenantId": "Tenants-1"
    }
  ],
  "ProjectId": "Projects-1",
  "RunbookId": "Runbooks-1",
  "SpaceId": "Spaces-1"
}

Response

The requested list of Runbook Run previews

Idstring

Gets or sets a unique identifier for this resource.

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.

Linksobject

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

UseGuidedFailureModeByDefaultboolean

Example response

[
  {
    "Links": {
      "Self": "/api/..."
    }
  }
]

Changes

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