API reference

Organisation

The organisation a key belongs to. One call, and it is the quickest way to confirm a key works and see which tenant it is pointed at.

Operations

GET/v1/organisationorganisation.read
The organisation this key belongs to.

Example

bash

curl https://gateway.octopusoperations.co.za/v1/organisation \
  -H "Authorization: Bearer $OCTOPUS_API_KEY"

Scope

Reading needs organisation.read. Anything that changes data needs the matching .manage scope, which grants the .read alongside it. See scopes & permissions.