GET
/
api
/
v2
/
api-key
/
list
List API keys
curl --request GET \
  --url https://app.octavehq.com/api/v2/api-key/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "name": "Untitled",
      "key": "key",
      "product": {
        "oId": "oId",
        "name": "name"
      },
      "playbook": {
        "oId": "oId",
        "name": "name"
      },
      "template": {
        "oId": "<string>",
        "name": "name"
      },
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Authorizations

api_key
string
header
required

Query Parameters

limit
number
default:10

Limit

Required range: x > 0
Example:

10

offset
number | null
default:0

Offset

Required range: x >= 0
Example:

0

productOId
string

Product OId

playbookOId
string

Playbook OId

Response

200
application/json

List of API keys

The response is of type object.