HomeGuidesAPI Reference
API Reference

Update the global topology background map image

Updates the background map image used in all topology views across the Orchestrator. This is a global setting stored in the default configuration - individual user configurations inherit this value automatically. Only the image filename is required; it must reference a valid map image file. Requires READ_WRITE role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON object with 'default' key containing map image settings. The 'default' key is required and must contain an 'image' field with a non-empty filename.

Request body for updating the global map image.

default
object
required

Map settings must be stored under the 'default' key as it applies globally to all users.

Responses
204

Map image updated successfully. No content returned.

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