v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

API KEYS

View API Keys

Retrieve a list of API keys on this account

post/api_keys/view

Request body

idstring

A full API key to retrieve the information for.

searchstring

A search keyword used to refine the results.

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

Response

Successfully retrieved API keys

request_idstring required

Example response

{
  "data": [
    {
      "request_id": "aa253464-0bd0-467a-b24b-6159dcd7be60",
      "data": {
        "api_key": "api-000000000000********************",
        "username": "api-000000000000",
        "custom_rate_limit": true,
        "custom_ratelimit_value": 123,
        "custom_ratelimit_period": "0:30:00",
        "default_ratelimit_period": "unlimited",
        "ippool": 1234
      }
    }
  ],
  "request_id": "4b661d88-6b2d-11eb-8bb3-f23c92bb31d2"
}