Runbooks permissions

Permissions are available to help you manage access to Runbooks, these include:

RunbookViewYou can view all things runbooks-related (from the runbooks themselves, to their process, runs and snapshots).
RunbookEditYou can edit all things runbooks-related.
RunbookRunViewYou can view runbook runs.
RunbookRunDeleteYou can delete runbook runs.
RunbookRunCreateYou can create runbook runs (equivalent of DeploymentCreate in the deployment world).

You can limit your teams ability to create runbooks by disabling these permissions.

There are roles we include out-of-the-box to encapsulate these new permissions:

Runbook producerRunbook producers can view, edit and execute runbooks. This is useful for authors of runbooks, who need to edit, iterate-on, publish and execute their runbooks.
Runbook consumerRunbook consumers can view and execute runbooks. This is useful for users who are not authoring runbooks but need to view and run them.

Working with Runbooks via the Octopus API

Octopus Deploy is built API-first, which means everything you can do through the Octopus UI can be done with the API. In the API, we model the runbook and its process the same way, starting at the project:

  • Project
  • Runbooks (a project can have many runbooks, with RunbookView/RunbookEdit permissions.)
  • RunbookProcess (a runbook has one process / collection of steps, with ProcessEdit permissions.)
  • RunbookSnapshots (a runbook can have many snapshots, each with a unique name, with RunbookEdit permissions.)
  • RunbookRuns (a runbook snapshot will then be run/executed against an environment, with RunbookRunCreate permissions.)

We have provided lots of helpful functions for building your runbook process in the .NET SDK, or you can use the raw HTTP API if that suits your needs better.

Learn about using the Octopus REST API.

Record the HTTP requests made by the Octopus UI to see how we build your runbook processes using the Octopus API. You can do this in the Chrome developer tools, or using a tool like Fiddler.

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023