SIsilverflow
API Keys

List API Keys

This operation returns a (paged) list of all API Keys for the authenticated Agent.

Requires apiKeys:List permission.

get/apiKeys

Request

Query parameters

sortOrder'asc' | 'desc'

The sort order, __asc__ending or __desc__ending

limitinteger

The number of items to return

offsetTokenstring

The offset token. This token is returned in the response of previous request.

Response

A (paged) list of API Keys

offsetTokenstring
moreItemsboolean

Example response

{
  "offsetToken": "Q29uZ3JhdHVhbHRpb25zISBZb3Ugc3VjY2Vzc2Z1bGx5IGJhc2U2NC1kZWNvZGVkIHRoZSB2YWx1ZS4gWW91J3JlIG9uIGEgcm9sbCBzbyBrZWVwIGdvaW5nIQ==",
  "apiKeys": [
    {
      "key": "apk-1nM6msvaara1OMHzU7Zd",
      "status": "active",
      "description": "API Key for the data lake",
      "permissions": [
        "reports:All"
      ],
      "ipRanges": [
        "185.184.111.39/32"
      ],
      "created": "2021-05-27T10:57:52Z",
      "lastModified": "2021-05-27T10:57:52Z",
      "version": 1
    },
    {
      "key": "apk-1hPdFhmgaBzMS191nIbJ",
      "status": "active",
      "description": "API key for merchant management",
      "permissions": [
        "all:All"
      ],
      "ipRanges": [
        "185.184.111.90/32",
        "185.184.111.96/29"
      ],
      "created": "2021-05-27T11:07:30Z",
      "lastModified": "2021-05-27T11:07:30Z",
      "version": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.