Migration guide

Discover the main differences between old and new versions of endpoints.


Catalog

Search for catalog data

Old versionNew version
Catalog search
POST /catalog/stac/search
Catalog search by host name
POST /catalog/hosts/{host_name}/stac/search

Use the Catalog search by host name endpoint that allows searching among all data hosts as follows:

  1. Call the Get data hosts endpoint and choose a data host. Retrieve the name of the chosen data host from the data.content.name field.
  2. Use the chosen name as the {host_name} path parameter to call the Catalog search by host name endpoint.

Orders

Estimate a catalog order cost

Old versionNew version
Estimate a catalog order cost
POST /workspaces/{workspace_id}/orders/estimate
Estimate a catalog order cost
POST /workspaces/{workspace_id}/orders/estimate

The URL path of the Estimate a catalog order cost endpoint hasn't changed, but the request body schema is updated. Create a request body as follows:

  1. Call the Get data products endpoint and choose a data product. Retrieve the ID of the chosen data product from the data.content.id field.
  2. Use the chosen ID as the {data_product_id} path parameter to call the Get a JSON schema of an order form endpoint. It will provide you with the format for a future order estimation request.
  3. Call the Get data hosts endpoint and choose a data host. Retrieve the name of the chosen data host from the data.content.name field.
  4. Use the chosen name as the {host_name} path parameter to call the Catalog search by host name endpoint and choose a scene. Retrieve the ID of the chosen scene from the features.properties.id field.
  5. Create a request body for the Estimate a catalog order cost endpoint:
    • For the dataProduct parameter, use the chosen data product ID.
    • For the params object, use the required request body schema format for the chosen data product.
    • For the params.id parameter, use the chosen scene ID.
{
  "dataProduct": "b1f8c48e-d16b-44c4-a1bb-5e8a24892e69", // The data product ID
  "params": {
      "id": "42712243-a45c-4c8e-adfa-1ce01d27b718", // The scene ID
      <...> // The format of the payload is different for different data products
  }
}

Create an order

Old versionNew version
Create an order
POST /workspaces/{workspace_id}/orders
Create an order
POST /workspaces/{workspace_id}/orders

The URL path of the Create an order endpoint hasn't changed, but the request body schema is updated. Create a request body as follows:

  1. Call the Get data products endpoint and choose a data product. Retrieve the ID of the chosen data product from the data.content.id field.
  2. Use the chosen ID as the {data_product_id} path parameter to call the Get a JSON schema of an order form endpoint. It will provide you with the format for a future order creation request.

If you place a catalog order

  1. Call the Get data hosts endpoint and choose a data host. Retrieve the name of the chosen data host from the data.content.name field.
  2. Use the chosen name as the {host_name} path parameter to call the Catalog search by host name endpoint and choose a scene. Retrieve the ID of the chosen scene from the features.properties.id field.
  3. Create a request body for the Create an order endpoint:
    • For the dataProduct parameter, use the chosen data product ID.
    • For the params object, use the required request body schema format for the chosen data product.
    • For the params.id parameter, use the chosen scene ID.

If you place a tasking order

  1. Create a request body for the Create an order endpoint:
    • For the dataProduct parameter, use the chosen data product ID.
    • For the params object, use the required request body schema format for the chosen data product.
{
  "dataProduct": "b1f8c48e-d16b-44c4-a1bb-5e8a24892e69", // The data product ID
  "params": {
      "id": "42712243-a45c-4c8e-adfa-1ce01d27b718", // If needed, the scene ID
      <...> // The format of the payload is different for different data products
  }
}

Assets

List all assets

Old versionNew version
List assets
GET /workspaces/{workspace_id}/assets
Get assets
GET /v2/assets

Get information about an asset

Old versionNew version
Get asset
GET /workspaces/{workspace_id}/assets/{asset_id}
Get asset metadata
GET /v2/assets/{asset-id}/metadata

Create a download URL for an asset

Old versionNew version
Sign a URL that can be used to download an asset
GET /workspaces/{workspace_id}/assets/{asset_id}/downloadUrl
Create a download URL
POST /v2/assets/{asset-id}/download-url