Home

Octopus Deploy is a user-friendly automated deployment tool for .NET developers. This GitHub repository exists to provide documentation for the upcoming Octopus Deploy 2.0 HTTP API.

For Octopus Deploy 2.0, we're making a lot of changes and improvements to the API, and our goal is to make the Octopus user interface API driven. When we first built the API for Octopus Deploy, it didn't come with documentation. The goal of this GitHub repository is to document the API from the start.

To be clear, this is documentation for an upcoming, unreleased version of the API. While many of the concepts in this documentation also apply to the current API, some parts won't.

Jumping in

The Octopus Deploy API is available at:

http://<your-octopus-installation>/api

You'll need an API key to access the API. You can get your API key from your profile page on the Octopus web portal. This should be sent in the X-Octopus-ApiKey HTTP header, or in an apikey query string parameter.

Design goals

When building this new API, we will keep the following goals in mind:

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 have the HTML user inteface for the Octopus web portal dogfood the API
4. To have a nice client library for .NET available via NuGet

Learning more

Use the sidebar on the right to learn more about what the Octopus Deploy API supports.