Stac Collection Config - Get

Service:: Planetary Computer

API Version:: 2025-04-30-preview

Get Config
Get the complete user configuration for a given collection

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/{collectionId}/configurations?api-version=2025-04-30-preview

URI Parameters

Name	In	Required	Type	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Unique identifier for the STAC collection.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	UserCollectionSettings	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

UserCollectionSettings

The request has succeeded.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://geocatalog.spatio.azure.com/.default

Examples

StacCollectionConfig_Get

Sample request

HTTP

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/sentinel-2-l2a-tutorial-7/configurations?api-version=2025-04-30-preview

Sample response

Status code:: 200

{
  "tileSettings": {
    "minZoom": 12,
    "maxItemsPerTile": 35,
    "defaultLocation": null
  },
  "mosaicInfo": {
    "mosaics": [
      {
        "id": "default",
        "name": "Default",
        "description": "",
        "cql": []
      },
      {
        "id": "mos1",
        "name": "Most recent available",
        "description": "Most recent available imagery in this collection",
        "cql": []
      }
    ],
    "renderOptions": [
      {
        "id": "natural-color",
        "name": "Natural color",
        "description": "True color composite of visible bands (B04, B03, B02)",
        "type": "raster-tile",
        "options": "assets=B04&assets=B03&assets=B02&nodata=0&color_formula=Gamma RGB 3.2 Saturation 0.8 Sigmoidal RGB 25 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "natural-color-pre-feb-2022",
        "name": "Natural color (pre Feb, 2022)",
        "description": "Pre-Feb 2022 true color composite of visible bands (B04, B03, B02)",
        "type": "raster-tile",
        "options": "assets=B04&assets=B03&assets=B02&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "color-infrared",
        "name": "Color infrared",
        "description": "Highlights healthy (red) and unhealthy (blue/gray) vegetation (B08, B04, B03).",
        "type": "raster-tile",
        "options": "assets=B08&assets=B04&assets=B03&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "short-wave-infrared",
        "name": "Short wave infrared",
        "description": "Darker shades of green indicate denser vegetation. Brown is indicative of bare soil and built-up areas (B12, B8A, B04).",
        "type": "raster-tile",
        "options": "assets=B12&assets=B8A&assets=B04&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "agriculture",
        "name": "Agriculture",
        "description": "Darker shades of green indicate denser vegetation (B11, B08, B02).",
        "type": "raster-tile",
        "options": "assets=B11&assets=B08&assets=B02&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "normalized-difference-veg-inde",
        "name": "Normalized Difference Veg. Index (NDVI)",
        "description": "Normalized Difference Vegetation Index (B08-B04)/(B08+B04), darker green indicates healthier vegetation.",
        "type": "raster-tile",
        "options": "nodata=0&expression=(B08-B04)/(B08+B04)&rescale=-1,1&colormap_name=rdylgn&asset_as_band=true",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "moisture-index-ndwi",
        "name": "Moisture Index (NDWI)",
        "description": "Index indicating water stress in plants (B8A-B11)/(B8A+B11)",
        "type": "raster-tile",
        "options": "nodata=0&expression=(B8A-B11)/(B8A+B11)&rescale=-1,1&colormap_name=rdbu&asset_as_band=true",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      },
      {
        "id": "atmospheric-penetration",
        "name": "Atmospheric penetration",
        "description": "False color rendering with non-visible bands to reduce effects of atmospheric particles (B12, B11, B8A).",
        "type": "raster-tile",
        "options": "nodata=0&assets=B12&assets=B11&assets=B8A&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
        "vectorOptions": null,
        "minZoom": 9,
        "legend": null,
        "conditions": null
      }
    ],
    "defaultLocation": null,
    "defaultCustomQuery": null
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Cql	CQL model
CqlFilter	CQL Filter model
DefaultLocation	Defines a default geographic location for map visualization.
LegendConfigType	Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal).Defines the legend configuration types for data visualization.
Mosaic	Defines a named mosaic with filtering criteria.
MosaicInfo	Configuration for data mosaic visualization.
RenderOption	Defines visualization parameters for rendering data on a map.
RenderOptionCondition	Defines a condition for enabling a render option.
RenderOptionLegend	Configuration for generating a data legend.
RenderOptionType	Specifies the types of render options for map visualization.
RenderOptionVectorOptions	Defines parameters for vector tile rendering.
SortBy	SortBy model
TileSettings	Configuration for map tile visualization.
UserCollectionSettings	User-specific collection settings for visualization.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Cql

Object

CQL model

Name	Type	Description
filter	CqlFilter	Filter
filter-lang	string	Filter language
sortby	SortBy[]	Sort by

CqlFilter

Object

CQL Filter model

Name	Type	Description
args	CqlArgument[]	Arguments for the logical operator
op	string	Logical operator

DefaultLocation

Object

Defines a default geographic location for map visualization.

Name	Type	Description
coordinates	number[] (float)	Default center coordinates [latitude, longitude] for the map.
zoom	integer (int32)	Default zoom level for the map.

LegendConfigType

Enumeration

Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal).Defines the legend configuration types for data visualization.

Value	Description
continuous	Continuous color ramp legend.
classmap	Classified map with discrete colors for classes.
interval	Interval-based legend with discrete ranges.
none	No legend.

Mosaic

Object

Defines a named mosaic with filtering criteria.

Name	Type	Description
cql	Cql[]	A list of valid CQL2-JSON expressions used to filter the collection to moasic.
description	string	Detailed description of the mosaic.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unique identifier for the mosaic.
name	string maxLength: 30	Short descriptive name for the mosaic.

MosaicInfo

Object

Configuration for data mosaic visualization.

Name	Type	Description
defaultCustomQuery	object	A list of CQL-JSON expressions to use as the default for this collection.
defaultLocation	DefaultLocation	Default map location when displaying this collection.
mosaics	Mosaic[]	Predefined data mosaics available for this collection.
renderOptions	RenderOption[]	Available render options for visualizing the data.

RenderOption

Object

Defines visualization parameters for rendering data on a map.

Name	Type	Default value	Description
conditions	RenderOptionCondition[]		A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled
description	string		A longer description of the render option that can be used to explain its content.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unique identifier for the render option.
legend	RenderOptionLegend		Legend configuration for this render option.
minZoom	integer (int32) maximum: 24	12	Minimum zoom level at which to display this layer.
name	string maxLength: 40		Short descriptive name for the render option.
options	string		A URL query-string encoded string of TiTiler rendering options. Valid only for `raster-tile` types. See 'Query Parameters': https://developmentseed.org/titiler/endpoints/cog/#description
type	RenderOptionType	raster-tile	The type of rendering to apply (raster or vector).
vectorOptions	RenderOptionVectorOptions		Options for rendering vector tiles. Valid only for `vt-polygon` and `vt-line` types.

RenderOptionCondition

Object

Defines a condition for enabling a render option.

Name	Type	Description
property	string	Property name to check in the active CQL filter.
value	string	Value that the property must equal.

RenderOptionLegend

Object

Configuration for generating a data legend.

Name	Type	Description
labels	string[]	Text labels to display on the legend.
scaleFactor	number (float)	A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values.
trimEnd	integer (int32)	Number of items to trim from the end of the legend.
trimStart	integer (int32)	The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend.
type	LegendConfigType	Legend type to make, one of: `continuous`, `classmap`, `interval` or `none` (note, `none` is a string literal).

RenderOptionType

Enumeration

Specifies the types of render options for map visualization.

Value	Description
raster-tile	Raster tile rendering type.
vt-polygon	Vector tile polygon rendering type.
vt-line	Vector tile line rendering type.

RenderOptionVectorOptions

Object

Defines parameters for vector tile rendering.

Name	Type	Description
fillColor	string	Fill color for polygon features.
filter	string[]	MapBox GL filter expression to filter features.
sourceLayer	string	Name of the source layer in the vector tiles.
strokeColor	string	Stroke color for line features.
strokeWidth	integer (int32)	Width of line strokes in pixels.
tilejsonKey	string	Asset key containing the TileJSON URL.

SortBy

Object

SortBy model

Name	Type	Description
direction	string	Sort direction
field	string	Field to sort by

TileSettings

Object

Configuration for map tile visualization.

Name	Type	Description
defaultLocation	DefaultLocation	Default map location when displaying this collection.
maxItemsPerTile	integer (int32)	Maximum number of items to include in a single tile.
minZoom	integer (int32) maximum: 24	The minimum zoom level that can be requested for this collection. Provides a hard limit for the tile servers to ensure they don't get requests for low zoom levels, which would cause many files to be fetched and the tile servers to hang.

UserCollectionSettings

Object

User-specific collection settings for visualization.

Name	Type	Description
mosaicInfo	MosaicInfo	Settings for data mosaic visualization.
tileSettings	TileSettings	Settings for map tile visualization.

Share via

Stac Collection Config - Get

URI Parameters

Responses

Security

OAuth2Auth

Scopes

Examples

StacCollectionConfig_Get

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Cql

CqlFilter

DefaultLocation

LegendConfigType

Mosaic

MosaicInfo

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions

SortBy

TileSettings

UserCollectionSettings