STAC Collection Configuration

Update Collection Render Option

Update a render option for a given collection

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

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

Changed in 2 of the 8 revisions of this API.13

  • 2025-04-30-preview28e8cb36528911See the full diff
    • removed the success response with the status

      response-success-status-removed

    • api operation id StacCollectionRenderOptions_CreateOrReplace removed and replaced with StacCollectionRenderOptions_Replace

      api-operation-id-removed

  • 2025-04-30-preview00cbc3d6d8e02See the full diff
    • api operation id StacCollectionRenderOptions_Replace removed and replaced with StacCollectionRenderOptions_CreateOrReplace

      api-operation-id-removed

    • added the success response with the status

      response-success-status-added