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

MethodEndpointTitle
GET/v2/collectionsGet geospatial collections
GET/v2/collections/{collection-name}Get a geospatial collection
GET/v2/data-productsGet data products
GET/v2/data-products/{data-product-name}Get a data product

Tasking

MethodEndpointTitle
GET/v2/tasking/feasibilityGet feasibility studies for tasking orders
POST/v2/tasking/feasibility/{feasibility-id}Choose a feasibility study option
GET/v2/tasking/quotationGet quotations for tasking orders
POST/v2/tasking/quotation/{quotation-id}Decide on a quotation
GET/v2/coverage/orders/{order-id}Get coverage of order assets

Catalog

MethodEndpointTitle
POST/catalog/hosts/{host-name}/stac/searchSearch the catalog by host name
GET/catalog/{host-name}/image/{image-id}/thumbnailGet a thumbnail
GET/catalog/{host-name}/image/{image-id}/quicklookGet a quicklook

Orders

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

Geometries

MethodEndpointTitle
GET/v2/spatial/geometriesGet geometries
POST/v2/spatial/geometriesCreate 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

MethodEndpointTitle
GET/v2/processing/processesGet processes
GET/v2/processing/processes/{process-id}Get a process
GET/v2/processing/jobsGet processing jobs
GET/v2/processing/jobs/{job-id}Get a processing job
POST/v2/processing/processes/{process-id}/validationValidate input for a process
POST/v2/processing/processes/{process-id}/costDetermine the cost of a process
POST/v2/processing/processes/{process-id}/executionRun a process

Assets

MethodEndpointTitle
GET/v2/assetsGet assets
GET/v2/assets/{asset-id}Download an asset
POST/v2/assets/{asset-id}/download-urlCreate a download URL
GET/v2/assets/{asset-id}/metadataGet asset metadata
POST/v2/assets/{asset-id}/metadataUpdate asset metadata

STAC

MethodEndpointTitle
GET/v2/assets/stacGet a STAC catalog
GET/v2/assets/stac/collectionsGet STAC collections
GET/v2/assets/stac/collections/{collection-id}Get a STAC collection
GET/v2/assets/stac/collections/{collection-id}/itemsGet STAC items
GET/v2/assets/stac/collections/{collection-id}/items/{item-id}Get a STAC item
GET/v2/assets/stac/queryablesGet queryable filter parameters
POST/v2/assets/stac/searchGet specific STAC items

Webhooks

MethodEndpointTitle
GET/webhooks/eventsGet webhook events
GET/workspaces/{workspace-id}/webhooksGet webhooks
POST/workspaces/{workspace-id}/webhooksCreate 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}/testsTest a webhook

Credits

MethodEndpointTitle
GET/credit-packsGet credit packages
GET/credit-packs/{credit-pack-id}Get a credit package
GET/v2/payments/balancesGet the account balance
GET/accounts/me/credits/balance
deprecated		Get account balance

EULAs

MethodEndpointTitle
GET/v2/eulasGet EULAs
GET/v2/eulas/{eula-id}Get a EULA
GET/v2/eulas/{eula-id}/documentsGet 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