Search
Blog posts
Outage on octopus.com - report and learnings
Public incident report and our learnings about the octopus.com DNS disruption from January 25 – 26, 2023.Converting many environments to tenants via the Octopus API
Learn how to use the Octopus API to automate the creation of multiple tenants from many existing environments.
Loading...
Documentation
List users
An example script to list all users in an Octopus instance.Download Runbook Artifact
An example script to download a runbook artifact to a specified location.Create a new scheduled runbook trigger
An example script to create and publish a new runbook scheduled triggerRemove a project from team
An example script that removes a project from a team.Create and deploy a release
Example scripts to create and deploy a release.Run a health check
An example script that creates and runs a health check task.Clear sensitive variables
An example script that clears all sensitive variables.Disable project triggers
An example script that disables a project's triggers in Octopus using the REST API and Octopus.Client.Add library set to a project
An example script that adds a library variable set to a project.Add or update project variable
An example script that adds or updates a project variable.Find teams with role
An example script that finds all teams using a specific role.List users with role
An example script to list all users that have a specific role by team.Delete targets by role
An example script to delete targets by role.Register Listening Tentacle
An example script to register a listening tentacle using the REST API.Register Polling Tentacle
An example script to register a Polling Tentacle using the REST API.Cancel queued deployments
An example script to cancel queued deployments.Delete project releases
An example script that deletes releases for a project.Publish a runbook snapshot
An example script to publish an existing runbook snapshotCreate a release with specific version
An example script that creates a release with a specific version number.Delete projects with no process
An example script that deletes projects that have no deployment process in Octopus using the REST API and Octopus.Client.Download package from built-in feed
An example script that downloads a package from the built-in feed.Adding Environments
An example script to create environments in a Space.Create and publish a new runbook snapshot
An example script to create and publish a new runbook snapshotDownload Deployment Artifact
An example script to download a deployment artifact to a specified location.Update variable set variable value
An example script that loads variables from a variable set, looks for a match and replaces the variable value.Import projects
An example script that will import projects from a previously executed export task from another space on an Octopus instance.Export projects
An example script that will export projects that can be imported into a different space on the same, or different Octopus instance.List deployments to environment
An example script to retrieve a list of deployments to an environmentCan't find what you are looking for? You can also search our support forum.