Skip to content

Home

Jump to bottom
Nicholas Blumhardt edited this page Dec 13, 2013 · 16 revisions

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

In Octopus Deploy 2.0, we've made 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.

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. Learn more about authenticating.

Design goals

When building this new API, we worked with 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 interface for Octopus consume the API - this means that anything you can do via the application can also be done via 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.

Clone this wiki locally