API reference

Risks & issues

The risk register and the open issues list, rolled up across every project. Both are governed by projects.read: they are a view of project health, not a resource of their own.

Operations

GET/v1/risksprojects.read
The risk register across projects, ranked by score.
GET/v1/issuesprojects.read
Open issues across projects.

Example

bash

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

Scope

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