Runbooks

Get a Runbook Run Preview for a Runbook

Gets a Runbook Run Preview that describes what steps will/won't be run during a Runbook Run on a given environment (and tenant if supplied) for a Runbook.

get/spaces/{spaceIdentifier}/runbooks/{id}/runbookRuns/preview/{environment}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/runbooks/{id}/runbookRuns/preview/{environment}
  • 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

idstring required

ID of the Runbook

environmentstring required

ID of the Environment

Query parameters

includeDisabledStepsboolean

Boolean to include/exclude disabled steps from response

projectIdstring

ID of the Project

tenantstring

ID of the Tenant

Response

Success

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.