The overview of the UP42 API.
Looking for API guides?
Explore our detailed API tutorials designed to guide you through every step of the process.
Server URLs:
- For the authentication endpoint:
auth.up42.com - For the rest of the endpoints:
api.up42.com
Authentication
| Method | Endpoint | Title |
|---|---|---|
| POST | /realms/public/protocol/openid-connect/token | Generate an access token |
Glossary
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/collections | Get geospatial collections |
| GET | /v2/collections/{collection-name} | Get a geospatial collection |
| GET | /v2/data-products | Get data products |
| GET | /v2/data-products/{data-product-name} | Get a data product |
Tasking
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/tasking/feasibilitydeprecated | Get feasibility studies for tasking orders |
| PATCH | /v2/tasking/feasibility/{feasibility-id}deprecated | Choose a feasibility study option |
| GET | /v2/tasking/quotation | Get quotations for tasking orders |
| PATCH | /v2/tasking/quotation/{quotation-id} | Decide on a quotation |
| GET | /v2/coverage/orders/{order-id} | Get coverage of order assets |
| GET | /v2/tasking/feasibility-studies | Get feasibility studies for tasking orders |
| PATCH | /v2/tasking/feasibility-studies/{feasibility-study-id} | Choose a feasibility study option |
Catalog
| Method | Endpoint | Title |
|---|---|---|
| POST | /catalog/hosts/{host-name}/stac/search | Search the catalog by host name |
| GET | /catalog/{host-name}/image/{image-id}/thumbnail | Get a thumbnail |
| GET | /catalog/{host-name}/image/{image-id}/quicklook | Get a quicklook |
Orders
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/orders | Get orders |
| POST | /v2/orders | Create an order |
| GET | /v2/orders/{order-id} | Get an order |
| PATCH | /v2/orders/{order-id} | Update an order |
| POST | /v2/orders/estimate | Estimate the cost of an order |
| GET | /orders/schema/{data-product-id} | Get a JSON schema of an order form |
Geometries
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/spatial/geometries | Get geometries |
| POST | /v2/spatial/geometries | Create a geometry |
| GET | /v2/spatial/geometries/{geometry-id} | Get a geometry |
| DELETE | /v2/spatial/geometries/{geometry-id} | Delete a geometry |
| PATCH | /v2/spatial/geometries/{geometry-id} | Update a geometry |
Processing
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/processing/processes | Get processes |
| GET | /v2/processing/processes/{process-id} | Get a process |
| GET | /v2/processing/jobs | Get processing jobs |
| GET | /v2/processing/jobs/{job-id} | Get a processing job |
| POST | /v2/processing/processes/{process-id}/validation | Validate input for a process |
| POST | /v2/processing/processes/{process-id}/cost | Determine the cost of a process |
| POST | /v2/processing/processes/{process-id}/execution | Run a process |
Assets
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/assets | Get assets |
| GET | /v2/assets/{asset-id} | Download an asset |
| POST | /v2/assets/{asset-id}/download-url | Create a download URL |
| GET | /v2/assets/{asset-id}/metadata | Get asset metadata |
| POST | /v2/assets/{asset-id}/metadata | Update asset metadata |
STAC
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/assets/stac | Get a STAC catalog |
| GET | /v2/assets/stac/collections | Get STAC collections |
| GET | /v2/assets/stac/collections/{collection-id} | Get a STAC collection |
| GET | /v2/assets/stac/collections/{collection-id}/items | Get STAC items |
| GET | /v2/assets/stac/collections/{collection-id}/items/{item-id} | Get a STAC item |
| PATCH | /v2/assets/stac/collections/{collection-id}/items/{item-id} | Update a STAC item |
| GET | /v2/assets/stac/queryables | Get queryable filter parameters |
| POST | /v2/assets/stac/search | Get specific STAC items |
Webhooks
| Method | Endpoint | Title |
|---|---|---|
| GET | /webhooks/events | Get webhook events |
| GET | /workspaces/{workspace-id}/webhooks | Get webhooks |
| POST | /workspaces/{workspace-id}/webhooks | Create a webhook |
| GET | /workspaces/{workspace-id}/webhooks/{webhook-id} | Get a webhook |
| PUT | /workspaces/{workspace-id}/webhooks/{webhook-id} | Update a webhook |
| DELETE | /workspaces/{workspace-id}/webhooks/{webhook-id} | Delete a webhook |
| POST | /workspaces/{workspace-id}/webhooks/{webhook-id}/tests | Test a webhook |
Credits
| Method | Endpoint | Title |
|---|---|---|
| GET | /credit-packs | Get credit packages |
| GET | /credit-packs/{credit-pack-id} | Get a credit package |
| GET | /v2/payments/balances | Get the account balance |
| GET | /accounts/me/credits/balancedeprecated | Get account balance |
EULAs
| Method | Endpoint | Title |
|---|---|---|
| GET | /v2/eulas | Get EULAs |
| GET | /v2/eulas/{eula-id} | Get a EULA |
| GET | /v2/eulas/{eula-id}/documents | Get EULA documents |
| GET | /v2/eulas/{eula-id}/documents/{eula-document-id} | Get a EULA document |
| PATCH | /v2/eulas/{eula-id}/documents/{eula-document-id} | Accept a EULA document |