Information

Account Information

Information of the active API endpoints, rate limits and usage for an account.

get/v1/account/

Request

Query parameters

app_partnerstring

A short identifier, code, or handle.

Your product name.

app_namestring

A short identifier, code, or handle.

Appliance, module, or playbook, or any combination of these.

app_versionstring

A short identifier, code, or handle.

Version of your integration/connector.

format'html' | 'json' | 'xml'

The desired response format.

Specifies the desired response format.

Response

OK

Example response

{
  "response": {
    "account": {
      "api_username": "api_user",
      "active": true
    },
    "products": [
      {
        "id": "domain-profile",
        "per_month_limit": "50000",
        "per_hour_limit": null,
        "per_minute_limit": "120",
        "absolute_limit": null,
        "usage": {
          "today": "0",
          "month": "1"
        },
        "expiration_date": "2027-12-30"
      }
    ]
  }
}

Changes

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