Search

Blog posts

Octopus Deploy 2.0 API changes - RFC

For Octopus Deploy 2.0 we'll be making some improvements to the HTTP API, as well as documenting it on GitHub.

Cloning a space using the Octopus API

With the Octopus API, it is possible to clone almost everything you need in a space.

Interacting with the Octopus Deploy API using PowerShell

Learn how to use your PowerShell skills to make API related calls to Octopus Deploy.

Importing variables with the Octopus REST API

How the REST API can be used to add variables

Hashing API keys to improve security

From Octopus 2.2 onwards we're going to be storing API keys using a one-way hash function

Scripting the creation of Octopus API keys

Learn how to script the creation of an API key for use with the Octopus REST API, and how to use browser developer tools to explore the Octopus API in action.

Migrating 426 Nancy API endpoints to ASP.NET Core controllers

We migrated Octopus Deploy to a more standardized way of writing an API, using ASP.NET controllers. Learn about our implementation strategy: Derisk, Enable, Finish.

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.

Using the Octopus API with Bash and jq

Learn how to work with the Octopus API using Bash and jq.

Faster deployments with the Executions API

The Executions API is a new set of endpoints that dramatically improves the performance of operations.

What does Microsoft deprecating Azure Service Management APIs mean for Octopus Users?

As Azure begin to deprecate their Azure Service Management APIs, this has knock-on effects for Octopus Users. Although Cloud Service deployments will keep working, Azure Certificate Management Accounts will no longer provide such a rich UX experience.

Ask Octopus Episode 2 - Service Accounts, Get Project by Name via API, Deployment Triggers

Once a week a few of us will gather to talk about some of the most interesting questions we have gotten over the past week and how we went about solving them.

Learn how to call the Jenkins REST API from PowerShell

A dive into the Jenkins REST API, with examples in PowerShell for creating new jobs

RFC: Octopus Reactions - Integration toolkit

A proposal for a feature we're calling Reactions. A set of tools to enable event based integration with a wide range of third party products. We'd love you to have your say!
Loading...

Documentation

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.

Octopus REST API

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

Create an API Key

An example script that creates an API Key.

API

The Insights API

Call the Jenkins REST API from PowerShell

Learn how to call the Jenkins REST API from PowerShell

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.

Path

Set the file paths that Octopus will use for storage

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

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