Octopus API

Legacy Uncategorised
1

Hello everybody,

I’m studying possibilities of Octopus Deploy system. But unfortunately there is no much information about Octopus API (or I couldn’t find it). For example, I couldn’t find any information about existing methods. Please note that Octopus Deploy documentation is pretty cool :slight_smile:

The main question: what can I do with Octopus API? In particular, can I perform a full auto-deployment cycle with only API functionality, without UI? Speaking about auto-deployment cycle I mainly mean these actions:

  • registration of new application (.NET Winservice, Webservice)
  • creation of new release version for new or existed application
  • run of deployment process
  • creation on deployment steps (not really crucial)

I need it because I want to integrate Octopus with another system.
Looking forward to your answer. Thank you!

2

Forgot to mention it: I want to work with Octopus API in .NET C# App.

3

Hi,

Thanks for reaching out. We don’t have a lot of documentation around the API for .Net, but we can definitely give you a hand with it.

What can I do with Octopus API? In particular, can I perform a full auto-deployment cycle with only API functionality, without UI?

Anything you can do from the UI, you can also do it from the API. There are some things that are a lot easier to do from the UI though.

Registration of new application (.NET Winservice, Webservice)

This can be done. Here’s a list of most of the things you can deploy with Octopus http://docs.octopusdeploy.com/display/OD/Deploying+applications . If there’s one you cant find on that list, let us know.

Creation of new release version for new or existed application \ run of deployment process

This can definitely be done using the .Net client from C#. Here’s an example of how to create and deploy a release: https://gist.github.com/DamianMac/cab420adb9f9a915b028 . If you need more help using the API, just let us know (on a separate ticket if possible) and we’ll provide you with examples. You can also use Octo.exe to create and deploy releases from the cmd line http://docs.octopusdeploy.com/display/OD/Octo.exe+Command+Line

Creation on deployment steps (not really crucial)

This can be done, buts its not easy using the .Net client. Deployment steps are usually a thing that you don’t modify very often. We definitely recommend you to setup your deployment process and steps from the Web UI, and then trigger your deployments in any other way you want.

Hope this helps!

Dalmiro

4

Hi Dalmiro,

Many thanks for the detailed answer!