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.

Interacting with the Octopus Deploy API using PowerShell

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

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.

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.

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

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.

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

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.

Using the Octopus API with Bash and jq

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

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.

Importing variables with the Octopus REST API

How the REST API can be used to add variables

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.

Cloning a space using the Octopus API

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

Documentation

API

The Insights API

Call the Jenkins REST API from PowerShell

Learn how to call the Jenkins REST API from PowerShell

Octopus REST API

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

API examples

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

How to Create an API Key

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

Migration API

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

Create an API Key

An example script that creates an API Key.

Tenants

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

Feeds

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

Create a feed

An example script that creates a nuget feed in Octopus.

Create a tenant

An example script that creates a tenant.

Variables

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

Add library set to a project

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

Add or update project variable

An example script that adds or updates a project variable.

Clear sensitive variables

An example script that clears all sensitive variables.

Find projects using library set

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

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