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.
Loading...

Documentation

Find target usage

An example script that will loop through all the steps in the deployment process and runbooks and determine if a target is being used

Find library variable set variables usage

An example script that loads variables from a library variable set and finds usages in project variables, and optionally deployment processes and runbooks.

Find variable usage

An example script that finds usages of a variable, searching in project variables, and optionally deployment processes and runbooks.

Add an environment to step

An example script that scopes a step to an environment.

Create and deploy a release

Example scripts to create and deploy a release.

Create a project

An example script that creates a project.

Add library set to a project

An example script that adds a library variable set to a project.

Remove a project from team

An example script that removes a project from a team.

Export step templates

An example script that exports all step templates in a Space to files.

Download Runbook Artifact

An example script to download a runbook artifact to a specified location.

Download Deployment Artifact

An example script to download a deployment artifact to a specified location.

Find variable value usage

An example script that finds all variables with a specific value in project variables and library variable sets.

List users

An example script to list all users in 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.

Enable/disable project

An example script that enables or disables a project in Octopus.

Create 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.

Find projects using library set

An example script that finds all projects using a specific library variable set.

Change target's machine policy

An example script that changes a machine policy of a deployment target.

Cancel queued deployments

An example script to cancel queued deployments.

Get all steps using role

An example script to find all steps targeting a role.

Publish a runbook snapshot

An example script to publish an existing runbook snapshot

Add an environment to a team

An example script that adds an environment to a team user role.

Find teams with role

An example script that finds all teams using a specific role.

Upgrade targets

An example script that upgrades a list of deployment targets.

Download package from built-in feed

An example script that downloads a package from the built-in feed.

List users with editing roles

An example script to list all users that have any user roles (permissions) containing the words Edit, Create or Delete.

Import projects

An example script that will import projects from a previously executed export task from another space on an Octopus instance.

Update variable set variable value

An example script that loads variables from a variable set, looks for a match and replaces the variable value.

Can't find what you are looking for? You can also search our support forum.