API reference
Open console

Overview

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.

View OAS (JSON)

Server URLs:

  • For the authentication endpoint: auth.up42.com
  • For the rest of the endpoints: api.up42.com

Authentication

MethodEndpointTitle
POST/realms/public/protocol/openid-connect/tokenGenerate an access token

Glossary

MethodEndpointTitleAuth
GET/v2/collectionsGet geospatial collectionsNo
GET/v2/collections/{collection-name}Get a geospatial collectionYes
GET/v2/data-productsGet data productsNo
GET/v2/data-products/{data-product-name}Get a data productYes

Tasking

MethodEndpointTitleAuth
GET/v2/tasking/feasibility
deprecated		Get feasibility studies for tasking ordersYes
PATCH/v2/tasking/feasibility/{feasibility-id}
deprecated		Choose a feasibility study optionYes
GET/v2/tasking/quotationGet quotations for tasking ordersYes
PATCH/v2/tasking/quotation/{quotation-id}Decide on a quotationYes
GET/v2/coverage/orders/{order-id}Get coverage of order assetsYes
GET/v2/tasking/feasibility-studiesGet feasibility studies for tasking ordersYes
PATCH/v2/tasking/feasibility-studies/{feasibility-study-id}Choose a feasibility study optionYes

Catalog

MethodEndpointTitleAuth
POST/catalog/hosts/{host-name}/stac/searchSearch the catalog by host nameYes
GET/catalog/{host-name}/image/{image-id}/thumbnailGet a thumbnailYes
GET/catalog/{host-name}/image/{image-id}/quicklookGet a quicklookYes

Orders

MethodEndpointTitleAuth
GET/v2/ordersGet ordersYes
POST/v2/ordersCreate an orderYes
GET/v2/orders/{order-id}Get an orderYes
PATCH/v2/orders/{order-id}Update an orderYes
POST/v2/orders/estimateEstimate the cost of an orderYes
GET/orders/schema/{data-product-id}Get a JSON schema of an order formYes

Geometries

MethodEndpointTitleAuth
GET/v2/spatial/geometriesGet geometriesYes
POST/v2/spatial/geometriesCreate a geometryYes
GET/v2/spatial/geometries/{geometry-id}Get a geometryYes
DELETE/v2/spatial/geometries/{geometry-id}Delete a geometryYes
PATCH/v2/spatial/geometries/{geometry-id}Update a geometryYes

Processing

MethodEndpointTitleAuth
GET/v2/processing/processesGet processesNo
GET/v2/processing/processes/{process-id}Get a processNo
GET/v2/processing/jobsGet processing jobsYes
GET/v2/processing/jobs/{job-id}Get a processing jobYes
POST/v2/processing/processes/{process-id}/validationValidate input for a processYes
POST/v2/processing/processes/{process-id}/costDetermine the cost of a processYes
POST/v2/processing/processes/{process-id}/executionRun a processYes

Assets

MethodEndpointTitleAuth
GET/v2/assetsGet assetsYes
GET/v2/assets/{asset-id}Download an assetYes
POST/v2/assets/{asset-id}/download-urlCreate a download URLYes
GET/v2/assets/{asset-id}/metadataGet asset metadataYes
POST/v2/assets/{asset-id}/metadataUpdate asset metadataYes

STAC

MethodEndpointTitleAuth
GET/v2/assets/stacGet a STAC catalogYes
GET/v2/assets/stac/collectionsGet STAC collectionsYes
GET/v2/assets/stac/collections/{collection-id}Get a STAC collectionYes
GET/v2/assets/stac/collections/{collection-id}/itemsGet STAC itemsYes
GET/v2/assets/stac/collections/{collection-id}/items/{item-id}Get a STAC itemYes
PATCH/v2/assets/stac/collections/{collection-id}/items/{item-id}Update a STAC itemYes
GET/v2/assets/stac/queryablesGet queryable filter parametersYes
POST/v2/assets/stac/searchGet specific STAC itemsYes

Webhooks

MethodEndpointTitleAuth
GET/webhooks/eventsGet webhook eventsYes
GET/workspaces/{workspace-id}/webhooksGet webhooksYes
POST/workspaces/{workspace-id}/webhooksCreate a webhookYes
GET/workspaces/{workspace-id}/webhooks/{webhook-id}Get a webhookYes
PUT/workspaces/{workspace-id}/webhooks/{webhook-id}Update a webhookYes
DELETE/workspaces/{workspace-id}/webhooks/{webhook-id}Delete a webhookYes
POST/workspaces/{workspace-id}/webhooks/{webhook-id}/testsTest a webhookYes

Credits

MethodEndpointTitleAuth
GET/credit-packsGet credit packagesNo
GET/credit-packs/{credit-pack-id}Get a credit packageNo
GET/v2/payments/balancesGet the account balance Yes
GET/accounts/me/credits/balance
deprecated		Get account balanceYes

EULAs

MethodEndpointTitleAuth
GET/v2/eulasGet EULAsYes
GET/v2/eulas/{eula-id}Get a EULAYes
GET/v2/eulas/{eula-id}/documentsGet EULA documentsYes
GET/v2/eulas/{eula-id}/documents/{eula-document-id}Get a EULA documentYes
PATCH/v2/eulas/{eula-id}/documents/{eula-document-id}Accept a EULA documentYes