Info Queries

Info API endpoints are endpoints that yield information about Scanner such as metrics or configuration values. You can read Info with the Scanner API.

Query capacity

GET /v1/info/query_capacity

Retrieve query capacity metrics and configuration

Query parameters

Name	Type	Description
tenant_id required	string	Unique identifier for the tenant

Example

curl -G $API_BASE/v1/info/query_capacity \
--data-urlencode "tenant_id=00000000-0000-0000-0000-000000000001" \
-H "Authorization: Bearer $SCANNER_API_KEY" \
-H "Content-Type: application/json"

Response

Returns query capacity usage and configuration values for the given tenant for the current calendar month.

| Name | Type | Description | | this_month_used_query_capacity_gb | number | The amount of query capacity used this month. | | this_month_provisioned_query_capacity_gb | number | The amount of query capacity provisioned for this month. | | this_month_on_demand_query_capacity_gb | number | The amount of query capacity used this month that is over the provisioned amount. | | number_of_days_this_month | number | The number of days in this month. | | contract_provisioned_query_capacity_gb_per_day | number | The amount of query capacity provisioned per day according to the contract. |

{
  "this_month_used_query_capacity_gb": 0.0,
  "this_month_provisioned_query_capacity_gb": 0.0,
  "this_month_on_demand_query_capacity_gb": 0.0,
  "number_of_days_this_month": 31,
  "contract_provisioned_query_capacity_gb_per_day": 0.0
}