HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference
GitHubAirheads Developer Community

Retrieve Floor Map Image

get
https://de1.api.central.arubanetworks.com/network-monitoring/v1/sitemaps//floors//image

Retrieves the background image associated with a specific floor within a site.

The image is returned as a binary stream. Callers must inspect the Content-Type response header to determine the exact image format before processing or displaying the image.

Supported Output Formats

  • image/png (Binary) — Always returned when raster=true; also returned when the original upload was a PNG file
  • image/jpeg (Binary) — Returned when raster=false and the original upload was a JPEG file
  • image/svg+xml (UTF-8 XML) — Returned when raster=false and the original upload was an SVG file
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 128

Id of the site where device/FloorPlan is present.

string
required
length ≤ 36

Id of the floor for which the map related information is requested.

Query Params
boolean
required

Controls which image variant is returned.

  • true — Returns a raster (bitmap) rendering of the floor map always as PNG (Content-Type: image/png), regardless of the original upload format.
  • false — Returns the original uploaded file in its native format. Check the Content-Type header, which will be one of: image/png, image/jpeg, or image/svg+xml.
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/png
image/jpeg
image/svg+xml
application/json

Updated 24 days ago

Did this page help you?