Get XQL Query Quota

Get the amount of query quota available and used.

Synopsis

URI
/public_api/v1/xql/get_quota/
HTTP Method
POST
Required License
Cortex XDR Pro per Endpoint or Cortex XDR Pro per TB

Description

Retrieve the amount of query quota available and used.

Request Fields

The body of this request contains a JSON object with the following fields:
Field
Description
request_data
(
Required
) A dictionary containing the API request fields.
Send an empty dictionary.
Request Example
curl -X POST https://api-{fqdn}/public_api/v1/xql/get_quota/ \ -H "x-xdr-auth-id:{key_id}" \ -H "Authorization:{key}" \ -H "Content-Type:application/json" \ -d '{ "request_data": {} }'

Success Response

Upon success, the HTTP response code is 200.
Field
Description
reply
JSON object containing the query result.
license_quota
Amount of daily quota allocated to your tenant based on your license type and size.
additional_purchased_quota
Available only in future releases.
Amount of query quota purchased.
used_quota
Amount of query quota used over the past 24 hours.
Success Response Example
{ "reply": { "license_quota": 5, "additional_purchased_quota": 0, "used_quota": 0.01555722222222223 } }

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:
Field
Description
400
Bad Request. Got an invalid JSON.
401
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
402
Unauthorized access. User does not have the required license type to run this API.
403
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
500
Internal server error. A unified status for API communication type errors.
Error Response Format
{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}

Recommended For You