AZazure
STAC Collection Configuration

Update Collection Render Option

Changed on

Update a render option for a given collection

put/stac/collections/{collectionId}/configurations/render-options/{renderOptionId}

Request

  • Base URL
    {endpoint}
  • URL
    {endpoint}/stac/collections/{collectionId}/configurations/render-options/{renderOptionId}
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: https://geocatalog.spatio.azure.com/.default

Path parameters

collectionIdstring required

Unique identifier for the STAC collection.

renderOptionIdstring required

Unique identifier for the render option.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

idstring required

Unique identifier for the render option.

namestring required

Short descriptive name for the render option.

descriptionstring

A longer description of the render option that can be used to explain its content.

type'raster-tile' | 'vt-polygon' | 'vt-line'

The type of rendering to apply (raster or vector).

optionsstring

A URL query-string encoded string of TiTiler rendering options. Valid only for raster-tile types.

See Query Parameters.

minZoominteger

Minimum zoom level at which to display this layer.

Response

The request has succeeded.

idstring required

Unique identifier for the render option.

namestring required

Short descriptive name for the render option.

descriptionstring

A longer description of the render option that can be used to explain its content.

type'raster-tile' | 'vt-polygon' | 'vt-line'

The type of rendering to apply (raster or vector).

optionsstring

A URL query-string encoded string of TiTiler rendering options. Valid only for raster-tile types.

See Query Parameters.

minZoominteger

Minimum zoom level at which to display this layer.

Changes

  • 2025-04-30-preview28e8cb365289Revision changes
    • breaking

      removed the success response with the status

    • info

      api operation id StacCollectionRenderOptions_CreateOrReplace removed and replaced with StacCollectionRenderOptions_Replace

  • 2025-04-30-preview00cbc3d6d8e0Revision changes
    • info

      api operation id StacCollectionRenderOptions_Replace removed and replaced with StacCollectionRenderOptions_CreateOrReplace

    • info

      added the success response with the status