Quota API Reference

• QuotaReservations
  • getGet all quota reservations as a paginated list.
  • postCreate a quota reservation.
  • postAdd a bulk request to create quota reservations.
  • postCalculate quota reservation estimate.
  • getGet all jobs as a paginated list.

API docs by Redocly

Quota API (1.0.0)

Download OpenAPI specification:Download

Query and manage quota and product access related data

QuotaReservations

Get all quota reservations as a paginated list.

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

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

https://api.planet.com/public/quota-reservations/

Response samples

• 200
• 400

Content type

application/json

{

• "meta": {

  • "args": { },
  • "count": 0,
  • "next": "string",
  • "prev": "string"

  },
• "results": [

  • {

    • "amount": 0,
    • "aoi_ref": "string",
    • "collection_id": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "id": 0,
    • "organization_id": 0,
    • "product_id": 0,
    • "state": "string",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "url": null,
    • "user_id": 0

    }

  ]

}

Create a quota reservation.

Create a quota reservation.

Request Body schema: application/json

required

The new quota reservation you want to create.

aoi_refs	Array of strings
collection_id	string
product_id	integer

Responses

https://api.planet.com/public/quota-reservations/

Request samples

• Payload

Content type

application/json

{

• "aoi_refs": [

  • "string"

  ],
• "collection_id": "string",
• "product_id": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "quota_remaining": "string",
• "quota_reservations": [

  • {

    • "aoi_ref": "string",
    • "id": 0,
    • "quota_used": 0,
    • "state": "string"

    }

  ],
• "quota_total": 0,
• "quota_used": 0,
• "url": null

}

Add a bulk request to create quota reservations.

Add a bulk request to create quota reservations.

Request Body schema: application/json

required

The new quota reservations you want to create.

aoi_refs	Array of strings
collection_id	string
product_id	integer

Responses

https://api.planet.com/public/quota-reservations/bulk-reserve

Request samples

• Payload

Content type

application/json

{

• "aoi_refs": [

  • "string"

  ],
• "collection_id": "string",
• "product_id": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "quota_remaining": "string",
• "quota_reservations": [

  • {

    • "aoi_ref": "string",
    • "id": 0,
    • "quota_used": 0,
    • "state": "string"

    }

  ],
• "quota_total": 0,
• "quota_used": 0,
• "url": null

}

Calculate quota reservation estimate.

Calculate quota reservation estimate.

Request Body schema: application/json

required

The product access ID and list of AOI refs that you want an estimate for.

aoi_refs	Array of strings
collection_id	string
product_id	integer

Responses

https://api.planet.com/public/quota-reservations/estimate

Request samples

• Payload

Content type

application/json

{

• "aoi_refs": [

  • "string"

  ],
• "collection_id": "string",
• "product_id": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "estimated_costs": [

  • {

    • "aoi_ref": "string",
    • "cost": 0

    }

  ],
• "quota_remaining": "string",
• "total_cost": 0

}

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

https://api.planet.com/public/quota-reservations/jobs

Response samples

• 200
• 400

Content type

application/json

{

• "meta": {

  • "args": { },
  • "count": 0,
  • "next": "string",
  • "prev": "string"

  },
• "results": [

  • {

    • "collection_id": "string",
    • "id": 0,
    • "organization_id": 0,
    • "percentage": 0,
    • "processed_items": 0,
    • "status": "string",
    • "total_items": 0,
    • "type": "string"

    }

  ]

}