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

Working directly with the Client

How to use the IOctopusClient type in the Octopus.Client library.

Output variables

Output variables allow you to set dynamic variables in one step that can be used in subsequent steps.

How to regenerate certificates with Octopus Server and Tentacle

How to regenerate the certificates used for communication between Octopus Server and its Tentacles.

Logging messages from scripts

When your scripts emit messages Octopus will display the messages in the Task Logs at the most appropriate level for the message.

Output variables

Your scripts can emit variables that are available in subsequent deployment steps.

Artifacts

Artifacts in Octopus provide a convenient way to collect files from remote machines during deployments.

Using variables in scripts

With Octopus you can define variables for use with your custom scripts.

New Octopus Target Command

Function for creating an Octopus target for a step package

Working with Spaces

How to work with Spaces in the Octopus.Client library.

Delete a Space

An example script to delete a space.

Updating Linux

With Octopus Deploy you can update and patch Linux machines with a runbook as part of a routine operations task.

Error handling

Error handling for scripts in Octopus.

Add a Space with environments

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

Add a target role

An example script that adds a target role to a deployment target.

Delete targets by name

An example script to delete targets by matching a specified name.

Create an API Key

An example script that creates an API Key.

Create a feed

An example script that creates a nuget feed in Octopus.

Enable/disable machine

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

Delete a feed

An example script that deletes an existing feed in Octopus using the REST API and Octopus.Client.

Retrieve all feeds

An example script that retrieves all feeds in Octopus.

Delete a project

An example script that deletes a project.

Disable project triggers

An example script that disables a project's triggers in Octopus using the REST API and Octopus.Client.

Update release variable snapshot

An example script that updates the variable snapshot for a release.

Delete targets by role

An example script to delete targets by role.

Create a project

An example script that creates a project.

Create a runbook

An example script that creates a runbook.

Run a published runbook

An example script to run a published runbook.

Using in an Octopus Step

How to use the Octopus.Client library from inside Octopus, for example within a script step.

Working with Resources

How to load, modify and save resources with the Octopus.Client library.

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