Octopus
Octopus Developersgateway.octopusoperations.co.za/v1

API reference

Documents

Files held against the organisation. Reading one returns a short-lived download URL rather than the bytes: the file never passes through the API.

Operations

  • GET/v1/documentsdocuments.read

    Documents.

  • GET/v1/documents/:iddocuments.read

    One document, with a download URL.

Example

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

Scope

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