Octopus
Octopus Developersgateway.octopusoperations.co.za/v1

API reference

Clients

The companies you work for. Projects, events and issues can all reference a client.

Operations

  • GET/v1/clientsclients.read

    Every client.

  • POST/v1/clientsclients.manage

    Create a client.

  • GET/v1/clients/:idclients.read

    One client.

  • PATCH/v1/clients/:idclients.manage

    Change a client.

Example

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

Scope

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