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

Create a certificate

An example script to add a certificate to the Octopus certificate library.

Replace existing certificate

An example script to replace an existing certificate in Octopus Deploy.

Deployment process

This section includes examples of how to use the REST API to manage a project's deployment process in Octopus.

Add an environment to step

An example script that scopes a step to an environment.

Add a run a script step

An example script to add a run a script step to a project.

Get all steps using role

An example script to find all steps targeting a role.

Deployments

This section includes examples of how to use the REST API to create and manage deployments in Octopus.

Cancel queued deployments

An example script to cancel queued deployments.

Create and deploy a release

Example scripts to create and deploy a release.

Deployment targets

This section includes examples of how to use the REST API to create and manage deployment targets in Octopus.

Add an Azure Web App

An example script to add an Azure Web App as a deployment target.

Change target's machine policy

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

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.

Projects

This section includes examples of how to use the REST API to create and manage projects in Octopus.

Create a project

An example script that creates a project.

Releases

This section includes examples of how to use the REST API to create and manage releases in Octopus.

Delete project releases

An example script that deletes releases for a project.

Runbooks

This section includes examples of how to use the REST API to create and manage runbooks in Octopus.

Create a runbook

An example script that creates a runbook.

Publish a runbook snapshot

An example script to publish an existing runbook snapshot

Run a published runbook

An example script to run a published runbook.

Spaces

This section includes examples of how to use the REST API to create and manage spaces in Octopus.

Add a Space with environments

An example script to create a new space and populate it with some default environments.

Delete a Space

An example script to delete a space.

Get all steps that use a package

An example script to find all steps that reference a specific package.

Tag sets

This section includes examples of how to use the REST API to create and manage Tenant tag sets in Octopus.

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