Developers

Build on your own operations data

Everything the Octopus web app can do, your software can do too, through the same API, checked by the same rules. Read and change projects, tasks, people, assets and the calendar over REST; subscribe to changes as they happen; or have them delivered to you as signed webhooks.

Endpoints

36

Scopes

18

Version

v1

Realtime

Yes

How it fits together

There are three ways in, and one set of rules behind all of them. The browser app, the REST API and the realtime connection are answered by the same logic, so a rule enforced for a person is enforced identically for your application, and there is no second implementation to drift out of step.

Follow a write. Your application calls POST /v1/tasks. Octopus checks your key, checks the scope, and applies the change exactly as it would for somebody clicking the same button in the app.

Two things follow from that. A write is confirmed the moment it is accepted, so a read taken in the same instant can occasionally still show the previous value, normally a few milliseconds, not seconds. And the same change is delivered to your realtime connection and to any webhook you have registered, which is why you never need to poll.

Where to go next