Skip to main content

Quota Reservations API Reference

Quota API (1.0.0)

Download OpenAPI specification:Download

Query and manage quota and product access related data

QuotaReservations

Get all quota reservations

Retrieve a paginated list of quota reservations for the current organization. Supports filtering, sorting, and field selection.

query Parameters
fields
string(\w+)(,\w+)*

List of comma separated model fields to return only.

limit
number <integer>

Limit parameter for paging output.

offset
number <integer>

Offset parameter for paging output.

sort
string[+-]?\w+

Sort specification, can be (ascending order) or - (descending order).

{field}__{operator}
string

Filter operations on fields are available with query parameters giving field name and operator. Available operators are eq, lt, lte, gt, gte, ne, like, ilike, icontains, isnull, in, notin. The like operator is case-sensitive and takes a % wildcard. ``ilikeis the same aslike but case-insensitive. icontains performs a case-insensitive query searching only for matching substrings. isnull accepts 0 for IS NOT NULL, and everything else for IS NULL. like, ilike, and icontains operations are only available for string fields.

{field}
string

Shorthand for {field}__eq filter.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}

Create a quota reservation

Create a quota reservation for the specified product and area of interest references. Use the product_id parameter which corresponds to the 'id' field returned from the /my/products endpoint.

Request Body schema: application/json
required

The quota reservation to create

aoi_refs
Array of strings

List of area of interest references

collection_id
string

Optional collection ID

product_id
integer

Product ID from /my/products endpoint

Responses

Request samples

Content type
application/json
{
  • "aoi_refs": {
    },
  • "product_id": 12345
}

Response samples

Content type
application/json
{
  • "quota_remaining": "string",
  • "quota_reservations": [
    ],
  • "quota_total": 0,
  • "quota_units": "string",
  • "quota_used": 0,
  • "url": null
}

Create bulk quota reservations asynchronously

Submit a bulk request to create quota reservations. This operation is processed asynchronously and returns a job ID to track the progress. The product_id parameter corresponds to the 'id' field returned from the /my/products endpoint.

Request Body schema: application/json
required

The bulk quota reservations to create

aoi_refs
Array of strings

List of area of interest references

collection_id
string

Optional collection ID

product_id
integer

Product ID from /my/products endpoint

Responses

Request samples

Content type
application/json
{
  • "aoi_refs": {
    },
  • "collection_id": "collection_001",
  • "product_id": 12345
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "status": "pending"
}

Calculate quota reservation estimate without creating reservations

Calculate an estimate for quota usage given a product and list of area of interest (AOI) references. This endpoint helps users understand the quota cost of their intended reservations before actually creating them. It does NOT create any reservations or modify quota - it only provides estimates.

The product_id parameter corresponds to the 'id' field returned from the /my/products endpoint.

Important: The quota_remaining field shows your current available quota and does NOT subtract the cost of the AOIs being estimated. To determine if you have sufficient quota for the request, compare total_cost against quota_remaining.

Response fields:

  • total_cost (float): The total quota cost for all requested AOI refs in this estimate. This is the sum of all individual AOI costs and represents how much quota would be consumed if you were to reserve all the requested AOIs.

  • quota_remaining (float): Your current available quota after accounting for all existing reservations. This value does NOT include/subtract the cost of the AOIs being estimated. May be null if the product has unlimited quota.

  • quota_total (float): The total quota originally allocated to this product access. This is your quota limit before any reservations. May be null if unlimited.

  • estimated_costs (array): Detailed breakdown of quota costs per AOI ref. Each item contains:

    • aoi_ref (string): The AOI reference
    • cost (float): The quota cost for this specific AOI
  • quota_units (string): The units of measurement for all quota values (e.g., "square_meter").

Example usage: If quota_total=1000, quota_remaining=700 (meaning 300 already reserved), and total_cost=500, then you have sufficient quota since 500 < 700. After reservation, quota_remaining would be 200.

Request Body schema: application/json
required

The product and AOI refs to estimate

aoi_refs
Array of strings

List of area of interest references

collection_id
string

Optional collection ID

product_id
integer

Product ID from /my/products endpoint

Responses

Request samples

Content type
application/json
{
  • "aoi_refs": {
    },
  • "product_id": 12345
}

Response samples

Content type
application/json
Example
{
  • "estimated_costs": {
    },
  • "quota_remaining": 200000,
  • "quota_total": 1000000,
  • "quota_units": "square_meter",
  • "total_cost": 800000
}

Get all jobs as a paginated list.

Get all jobs as paginated list. If successful, returns a list of jobs.

query Parameters
fields
string(\w+)(,\w+)*

List of comma separated model fields to return only.

limit
number <integer>

Limit parameter for paging output.

offset
number <integer>

Offset parameter for paging output.

sort
string[+-]?\w+

Sort specification, can be (ascending order) or - (descending order).

{field}__{operator}
string

Filter operations on fields are available with query parameters giving field name and operator. Available operators are eq, lt, lte, gt, gte, ne, like, ilike, icontains, isnull, in, notin. The like operator is case-sensitive and takes a % wildcard. ``ilikeis the same aslike but case-insensitive. icontains performs a case-insensitive query searching only for matching substrings. isnull accepts 0 for IS NOT NULL, and everything else for IS NULL. like, ilike, and icontains operations are only available for string fields.

{field}
string

Shorthand for {field}__eq filter.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}