HomeGuidesAPI Reference
API Reference

Get overlay configurations

Retrieves overlay configurations from the Orchestrator. When called without parameters, returns all configured overlays from cache with ETag support for caching optimization. When overlayId is provided, returns the specific overlay configuration. Response is always an array of OverlayConfig objects.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
≥ 1

Unique identifier of a specific overlay to retrieve. When omitted, all overlays are returned.

Responses

304

Not Modified - Content unchanged since last request. Returned when ETag matches.

401

Unauthorized - User lacks READ or READ_WRITE permissions.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json