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:
- To be friendly and easy to figure out.
- To be hypermedia driven, using links and the occasional URI template (read more).
- To be comprehensive - 100% of the actions that you perform via the Octopus UI can be performed via the API.
- To have a nice client library for .NET available via NuGet.
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
You can view the API through the Octopus Demo server at demo.octopus.com/swaggerui/index.html.
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.
Documentation and Samples
In this section
The following topics are explained further in this section:
- How to Create an API Key
- The Octopus Command Line (CLI)
- API examples
- Octopus.Server.exe command line
- Tentacle.exe command line
- Octopus.Migrator.exe command line
- Migration API
Need support? We're here to help.