---
title: "Get network map content"
method: GET
path: "/v1/objects/{object-id}/map"
tags: ["Objects"]
---

# Get network map content

`GET /v1/objects/{object-id}/map`

Return the content of a network map object: layout settings, link defaults, background,
and the element and link layout. Requires read access. Applies only to objects of class
`NetworkMap`.

## Path parameters

- `object-id` integer, required

## Response `200`

Network map content.

- NetworkMapContent — Content of a network map object - layout settings, link defaults, background, and element/link layout.
  - `mapType` integer — Map type (custom, layer-2 topology, IP topology, etc.).
  - `layout` integer — Automatic layout algorithm.
  - `flags` union — Map behavior/appearance flags. Returned as an object of booleans. On update it may be supplied either as such an object (only the keys present are changed; omitted keys are left unchanged) or, as a shortcut, as an integer bit mask that replaces the whole flag word.
    - object
      - `showStatusIcon` boolean
      - `showStatusFrame` boolean
      - `showStatusBackground` boolean
      - `showEndNodes` boolean
      - `calculateStatus` boolean
      - `filterObjects` boolean
      - `showLinkDirection` boolean
      - `useL1Topology` boolean
      - `centerBackgroundImage` boolean
      - `translucentLabelBackground` boolean
      - `dontUpdateLinkText` boolean
      - `fitBackgroundImage` boolean
      - `fitToScreen` boolean
      - `showAsObjectView` boolean
      - `showTraffic` boolean
      - `showWifiClients` boolean
    - integer — Raw flag bit mask (replaces the whole flag word).
  - `seedObjects` integer[] — Seed object IDs for topology maps.
  - `discoveryRadius` integer — Topology discovery radius (hops from seed).
  - `defaultLinkColor` integer — Default link color.
  - `defaultLinkColorSource` integer — Default link color source.
  - `defaultLinkRouting` integer — Default link routing algorithm.
  - `defaultLinkWidth` integer — Default link width.
  - `defaultLinkStyle` integer — Default link style.
  - `objectDisplayMode` integer — Object element display mode.
  - `backgroundColor` integer — Map background color.
  - `background` string, uuid — Background image UUID (or a special value for map/none). When set, the background geo-positioning fields below apply.
  - `backgroundLatitude` number — Background map center latitude.
  - `backgroundLongitude` number — Background map center longitude.
  - `backgroundZoom` integer — Background map zoom level.
  - `filter` string — NXSL object filter script source.
  - `linkScript` string — NXSL link styling script source.
  - `width` integer — Map canvas width.
  - `height` integer — Map canvas height.
  - `canvasType` integer — Map canvas type.
  - `initialViewMode` integer — Initial view mode when the map is opened.
  - `displayPriority` integer — Display ordering priority.
  - `elements` NetworkMapElement[] — Map elements. On update this fully replaces the element layout.
    - `id` integer — Element ID (unique within the map).
    - `type` integer, required — Element type code (e.g. object, decoration, DCI container, DCI image, text box).
    - `posX` integer — X position.
    - `posY` integer — Y position.
    - `flags` integer — Element flags.
  - `links` NetworkMapLink[] — Map links. On update this fully replaces the link layout.
    - `element1` integer — ID of the first linked element.
    - `element2` integer — ID of the second linked element.
    - `interface1` integer — Object ID of the interface at the first endpoint (0 if none).
    - `interface2` integer — Object ID of the interface at the second endpoint (0 if none).
    - `type` integer — Link type code.
    - `name` string — Link label.
    - `connectorName1` string — Connector label at the first endpoint.
    - `connectorName2` string — Connector label at the second endpoint.
    - `flags` integer — Link flags.
    - `colorSource` integer — Link color source.
    - `color` integer — Fixed link color (used when color source is "custom color").
    - `colorProvider` string — Name of the script providing the link color (used when color source is "script").
    - `config` string — Serialized JSON link configuration (e.g. referenced DCI list).

## Other responses

- `400` — Object is not a network map
- `401` — Unauthorized
- `403` — User does not have read access to the object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)