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/projects/{projectId}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant}

Request

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

idstring required

ID of the Runbook

environmentstring required

ID of the Environment

tenantstring required

ID of the Tenant

Query parameters

includeDisabledStepsboolean

Boolean to include/exclude disabled steps from response

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.