b296c3a60aa5
Update an existing Runbook
Path parameters
Identifier (ID or slug) of the space
The ID of the runbook to update, for example 'Runbooks-123'.
Request body
When a new run of this runbook is queued, automatically cancel earlier runs of it that are still queued and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged.
When a new run of this runbook is queued, automatically cancel an earlier run of it that is already executing and now superseded. This is a standing setting on the runbook, not an instruction to cancel anything right now. Omit to leave the current setting unchanged.
What a run does when a step fails. One of 'EnvironmentDefault' (follow the target environment's setting), 'Off' (fail the run immediately), or 'On' (pause the run and wait for someone to choose whether to retry, ignore or abort). Resets to 'Off' when omitted.
The runbook's complete environment list, used when EnvironmentScope is 'Specified'. This replaces the current list, so resubmit the existing environments you want to keep. The update is rejected if it would remove an environment that a project trigger still runs this runbook in.
Which environments the runbook may be run in. One of 'All' (every environment in the space), 'Specified' (only the environments listed in Environments), or 'FromProjectLifecycles' (only the environments used by the project's lifecycles). Resets to 'All' when omitted.
Fail a run when one of its target discovery steps finds no matching deployment targets, instead of letting the step succeed. Resets to false when omitted.
Re-download every package on each run instead of reusing the copy already cached on the deployment target. Resets to false when omitted.
The ID of the runbook to update, for example 'Runbooks-123'.
Whether the runbook can be run for tenants. One of 'Untenanted' (untenanted runs only), 'Tenanted' (a tenant must be supplied for every run), or 'TenantedOrUntenanted' (either is allowed). Resets to 'Untenanted' when omitted.
The ID of the project the runbook belongs to. Must be a project that stores its runbooks in the Octopus database.
The ID of the runbook snapshot to publish. Setting this to a different snapshot publishes that snapshot, which is what subsequent runs execute. Resubmit the current value to leave the published snapshot alone.
Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process.
The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks.
A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted.
Response
Confirmation that the Runbook has been modified, containing the updated Runbook
Gets or sets a unique identifier for this resource.
Gets or sets the username of the user who last modified this resource.
Gets or sets the date/time that this resource was last modified.
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
List of tags assigned to this runbook