Octopus Deploy Documentation

Octopus REST API

Last updated

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 is built on top of this API so all of the data and operations you can see and perform in the Octopus Web Portal can be performed over the REST API.

Octopus integrates with build servers, scripts, .NET applications, and anything else with its 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

Octopus 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/.

Server API

You can view the API through the Octopus Demo server at demo.octopus.app/swaggerui/index.html.

API and Spaces

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.

Documentation and Samples

Documentation and samples for the Octopus Deploy REST API are available both in our API examples and on the OctopusDeploy-API GitHub repository.

In this section

The following topics are explained further in this section:

Need support? We're here to help.