Account limits¶
The limits
service is accessible using the url path /v2/limits
.
It’s purpose is to verify account limits which are based on the account type.
curl -x GET 'https://api-pdns.deteque.com/v2/limits' \
-H 'Authorization: Bearer <AUTH TOKEN>'
The response objects will include your account’s tier access limits in the following format:
{
"account": {
"id": "12345678",
"maximum-dataset-size": 5000,
"allow-over-quota": 0,
"allow-advanced-search": 1,
"realtime-sockets": 0
},
"limits": {
"qpm": 10000,
"qpd": 2000
},
"current": {
"qpm": 88,
"qpd": 88,
"rpm": 2296,
"rpd": 2296
},
"status": 200
}
Each parameter of the response object has the following meaning:
status
: will be 200 in the case of success, otherwise an error occurredaccount
: an object which shows several account-related settingsid
: shows the account identifiermaximum-dataset-size
: shows the maximum number of records for each result set (also the maximum value that the query parameterlimit
may have)allow-over-quota
: can be 0 or 1 and shows if the account can perform over-quota queriesallow-advanced-search
: can be 0 or 1 and shows if the account is enabled for advanced search queriesrealtime-sockets
: can be 0 or 1 and shows if the account is enabled to connect to the realtime socket receiving the live feed of passive dns queries.
limits
: an object that contains the global limits of the accountqpm
: an integer showing the max number of queries per monthqpd
: an integer showing the max number of queries per day
current
: an object that contains the current status of the accountqpm
: shows the number of actual queries performed during the current monthqpd
: shows the number of actual queries performed during the current dayrpm
: shows the number of results received during the current monthrpd
: shows the number of results received during the current day