Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
FloorPlan

Retrieve Floor Map 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
get/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}/image

Query parameters

rasterboolean required
Example:true

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.

Response

Floor map image has been fetched for a given floor.