---
title: "Register Search"
method: POST
path: "/data/mosaic/register"
tags: ["Tiles for STAC Searches"]
---

# Register Search

`POST /data/mosaic/register`

Register a Search query

## Query parameters

- `api-version` string, required

## Request body

- RegisterMosaic — Input parameters for registering a new mosaic of STAC items
  - `collections` string[] — List of STAC collection IDs to include in the mosaic
  - `ids` string[] — List of specific STAC item IDs to include in the mosaic
  - `bbox` number[] — Geographic bounding box to filter items [west, south, east, north]
  - `intersects` Geometry — Represents a GeoJSON geometry object as defined by RFC 7946. Supported geometry types include: - **Point**: A single geographic coordinate. - **LineString**: A sequence of geographic coordinates forming a line. - **Polygon**: A closed shape defined by linear rings. - **MultiPoint**: A collection of Points. - **MultiLineString**: A collection of LineStrings. - **MultiPolygon**: A collection of Polygons. Used for spatial filtering in STAC.
    - `type` string, required — Discriminator property for Geometry.
    - `bbox` number[] — Optional bounding box of the geometry.
  - `query` object — Query
  - `filter` object — Filter
  - `datetime` string — Temporal filter in RFC 3339 format or interval
  - `sortby` StacSortExtension[] — Criteria for ordering items in the mosaic
    - `field` string, required — The field name to sort by.
    - `direction` 'asc' | 'desc', required — Defines the sorting directions for query results in STAC API.
  - `filter-lang` 'cql-json' | 'cql2-json' | 'cql2-text' — Choices for filter-lang value in a POST request. Based on https://github.com/stac-api-extensions/filter#queryables Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above. Defines the supported filter languages for STAC API queries.
  - `metadata` MosaicMetadata — Metadata information for mosaic or search results
    - `type` 'mosaic' | 'search' — Type of metadata resource
    - `bounds` string — Geographic bounding box in [west, south, east, north] format
    - `minzoom` integer — Minimum zoom level supported
    - `maxzoom` integer — Maximum zoom level supported
    - `name` string — Human-readable name for the resource
    - `assets` string[] — List of asset identifiers included in the resource
    - `defaults` object — Defaults

## Response `200`

The request has succeeded.

- TilerMosaicSearchRegistrationResponse — Response from a successful mosaic registration with search ID and related links
  - `searchid` string, required — Unique identifier for the registered search
  - `links` StacLink[] — Related links for the registered mosaic
    - `rel` string — The relationship type of the link.
    - `title` string — The title of the link.
    - `type` 'image/tiff; application=geotiff' | 'image/jp2' | 'image/png' | 'image/jpeg' | 'image/jpg' | 'image/webp' | 'application/x-binary' | 'application/xml' | 'application/json' | 'application/geo+json' | 'text/html' | 'text/plain' | 'application/x-protobuf' — The MIME type of the linked resource.
    - `href` string, required — The URL of the link.
    - `hreflang` string — The language of the linked resource.
    - `length` integer — The length of the linked resource.
    - `method` 'GET' | 'POST' — Specifies the HTTP method that the resource expects. Default: GET.
    - `headers` object — Object key-value pairs that map to headers. Example: { "Accept": "application/json" }.
    - `body` object — For POST requests, the resource can specify the HTTP body as a JSON object.
    - `merge` boolean — Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/orbital-microsoft-planetarycomputer.md) · [All operations](https://skmtc.net/azure/apis/orbital-microsoft-planetarycomputer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/orbital-microsoft-planetarycomputer/revisions/42447be18bc5/schema)