RunbookRuns

Create a new runbook run

post/runbook-runs/create/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/runbook-runs/create/v1
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Request body

DebugModestring

Contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the execution. One of "None", "Log" or "Debug"; leave unset for the default of "None".

DeploymentFreezeNamesstring[]

Active deployment freezes to override so this execution can proceed despite them. Overriding a freeze bypasses a deliberate block on deploying, so only set this when explicitly asked to. Requires DeploymentFreezeOverrideReason.

DeploymentFreezeOverrideReasonstring

Required, and must not be blank, whenever DeploymentFreezeNames is non-empty. Recorded against the override.

EnvironmentNamesstring[] required
ExcludedMachineNamesstring[]

A collection of machines in the target environment that should be excluded from the deployment.

ExcludedTargetTagNamesstring[]

A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be excluded from the deployment.

ForcePackageDownloadboolean

Whether to force downloading of already installed packages (flag, default false).

NoRunAfterstring date-time

Time at which a scheduled execution should expire if it has not started, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. Only meaningful alongside RunAt.

Prioritystring

Whether this execution jumps the task queue ahead of other queued tasks. One of "LifecycleDefault" (use the lifecycle's configured setting), "On" or "Off".

ProjectNamestring required
RunAtstring date-time

Time at which the execution should start (scheduling it for later), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.

RunbookNamestring required
SkipStepNamesstring[]

Steps that are to be skipped for this execution. A name that matches no step is logged as a warning rather than failing the command, so check the step name carefully.

Snapshotstring

Name or ID of the snapshot to run. If not supplied, the command will attempt to use the published snapshot.

SpaceIdstring required
SpaceIdOrNamestring required

Both this and SpaceId are required, and normally hold the same space ID; set both.

SpecificMachineNamesstring[]

A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed. A name that matches no machine fails the command.

SpecificTargetTagNamesstring[]

A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be included in the deployment.

Tenantsstring[]

The tenants to deploy.

TenantTagsstring[]

The tenant tags to filter tenants to deploy.

UseGuidedFailureboolean

If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.

Variablesobject

Name/value pairs for prompted variables. A prompted variable that is required and has no value supplied here fails the command, naming the variable.

Example request

{
  "SpaceId": "Spaces-1"
}

Response

Server tasks associated with the newly-created Runbook Run

Example response

{
  "RunbookRunServerTasks": [
    {
      "RunbookRunId": "RunbookRuns-1",
      "ServerTaskId": "ServerTasks-1"
    }
  ]
}

Changes

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