Stac Collection Render Options - Create Or Replace

Service:: Planetary Computer

API Version:: 2025-04-30-preview

Update Collection Render Option
Update a render option for a given collection

PUT https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/{collectionId}/configurations/render-options/{renderOptionId}?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.
renderOptionId	path	True	string maxLength: 500 pattern: .*	Unique identifier for the render option.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unique identifier for the render option.
name	True	string maxLength: 40	Short descriptive name for the render option.
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.
legend		RenderOptionLegend	Legend configuration for this render option.
minZoom		integer (int32) maximum: 24	Minimum zoom level at which to display this layer.
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	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.

Responses

Name	Type	Description
200 OK	RenderOption	The request has succeeded.
201 Created	RenderOption	The request has succeeded and a new resource has been created as a result.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

RenderOption

The request has succeeded.

201 Created

RenderOption

The request has succeeded and a new resource has been created as a result.

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

StacCollectionRenderOptions_CreateOrReplace

Sample request

HTTP

PUT https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/36fcb8da-9b15-49e0-b400-0d2e751e2061/configurations/render-options/atmospheric-penetration?api-version=2025-04-30-preview

{
  "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,
  "id": "atmospheric-penetration"
}

Sample response

Status code:: 201

{
  "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",
  "minZoom": 9
}

Status code:: 200

{
  "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",
  "minZoom": 9
}

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.
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.
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.

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.

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.

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.

Share via

Stac Collection Render Options - Create Or Replace

URI Parameters

Request Body

Responses

Security

OAuth2Auth

Scopes

Examples

StacCollectionRenderOptions_CreateOrReplace

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions