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

Node

Configure settings related to this Octopus Server node

New certificate

Creates a new certificate that Octopus Server can use to authenticate itself with its Tentacles

Metrics

Configure metrics logging

Lost Master Key

Get your Octopus Server working again after losing your Master Key

List instances

Lists all installed Octopus instances

License

 Import a license key

Import certificates

 Replace the certificate that Octopus Server uses to authenticate itself with its Tentacles

External Worker

Configure the external worker used to run deployment actions and scripts on the Octopus Server

Export certificates

Exports the certificate that Octopus Server can use to authenticate itself with its Tentacles

Delete instances

 Deletes an instance of the Octopus service

Database

 Create or drop the Octopus database

Create instances

 Registers a new instance of the Octopus service

Configure

Configure this Octopus instance

Check services

 Checks the Octopus instances are running

Built-in Worker

Configure the built-in worker used to run deployment actions and scripts on the Octopus Server

Admin

Reset admin user passwords, re-enable them, and ensure they are in the admin group

Octopus.Server.exe command line

Octopus.Server.exe is the executable that runs the Octopus instance, it can also be called from the command line.

Version

Shows the version information for this release of the Octopus Migrator

Partial export

Using the Octopus.Migrator.exe command line tool to export data to a directory filtered by a single project.

migrate

Imports data from an Octopus 2.6 backup

Migrator import

Using the Octopus.Migrator.exe command line tool to import data from an Octopus 3.0 or newer directory.

Migrator export

Using the Octopus.Migrator.exe command line tool to export data to a directory.

Octopus.Migrator.exe command line

Octopus.Migrator.exe is an Octopus command line tool that provides the ability to back-up and restore parts of an Octopus Deploy instance as well as migrate data from 2.6 builds.

Octopus.Client

Octopus.Client is an open source .NET library that makes it easy to write C# programs that interact with the Octopus Deploy REST API.

Migration API

Octopus includes a migration API that provides the ability to back-up and restore parts of an Octopus Deploy instance remotely.

How to Create an API Key

How to create an API key to interact with Octopus without the need for a username and password.

API examples

A set of examples using the Octopus REST API to accomplish tasks.

Calamari

Calamari is the command-line tool invoked by Tentacle during a deployment. It knows how to extract and install NuGet packages, run the Deploy.ps1 etc. conventions, modify configuration files, and all the other things that happen during an deployment.

Octopus REST API

Octopus integrates with build servers, scripts, external applications and anything else with its REST API.

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