This documentation is for Octopus Deploy Version 2018.12. View other versions

Octopus REST API

Last updated

Octopus as an API-First Application

Architecturally, Octopus Deploy is built API-first. This means that Octopus is built in layers - all data and operations are available over its REST API. The Octopus Web Portal (the main Octopus UI) is actually built on top of this API. In the Octopus Web Portal, we don't use any shortcuts - 100% of the data and operations that you can see and perform in the Octopus UI can be performed over the REST API.

The Octopus REST API is designed:

  1. To be friendly and easy to figure out.
  2. To be hypermedia driven, using links and the occasional URI template (read more).
  3. To be comprehensive - 100% of the actions that you perform via the Octopus UI can be performed via the API.
  4. To have a nice client library for .NET available via NuGet.

Using C#?
If you plan to use the REST API from C# or another .NET project, see the Octopus.Client assembly.

REST API Documentation via Swagger

As of Octopus 3.17, Octopus now includes the default Swagger UI for displaying the API documentation in a nice human readable way. To browse that UI just open your browser and go to [OctopusServerURL]/swaggerui/. The original Non-Swagger API page is still available and can always be accessed via [OctopusServerURL]/api/.

You can view the API through the Octopus Demo server at

API and Spaces

Spaces was introduced in Octopus 2019.1. If you are using spaces, you need to include the SpaceID in your API calls. If you do not include the SpaceID, your API calls will automatically use the default space.

In This Section

The following topics are explained further in this section: