HomeGuidesAPI Reference
API Reference

Get regional overlay configurations

Retrieves regional overlay configurations. When called without parameters, returns all overlays with their regional configurations as a nested map (overlayId → regionId → OverlayConfig). When both overlayId and regionId are provided, returns the specific configuration for that combination. Use regionId=0 to retrieve the global overlay configuration.

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

Unique identifier of the overlay to retrieve. Must be provided together with regionId to fetch a specific regional configuration.

int32
≥ 0

Region identifier for the overlay configuration. Use 0 for global configuration, or a positive integer for regional configurations. Must be provided together with overlayId.

Responses

204

No content - The specified overlay or region combination does not exist.

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