/

Docs
History
Schema
Generate

Filter operations

Agent Tunnels3

AI Chat7

AI Management3

AI Memory5

AI Operators14

AI Saved Prompts5

Alarm Categories5

Alarms10

Asset Management Schema5

Authentication2

Background Tasks1

Chat Bots7

Cloud Connectors1

Data Collection11

Data Export4

DCI Summary Tables7

Event Forwarders7

Event Processing Policy8

Event Templates5

Events1

Find2

Geo Areas5

Grafana8

Image Library6

Incidents10

Log Parsers2

Logs5

Mapping Tables5

Notification Channels9

Object Categories5

Object Tools10

Objects92

get/v1/objectsList objects
post/v1/objectsCreate a new object
get/v1/objects/{object-id}Get object details
delete/v1/objects/{object-id}Delete object
patch/v1/objects/{object-id}Update common object properties
patch/v1/objects/{object-id}/locationUpdate object geo location and postal address
patch/v1/objects/{object-id}/physical-placementUpdate object placement in a rack or chassis
patch/v1/objects/{object-id}/status-calculationUpdate object status calculation/propagation parameters
get/v1/objects/{object-id}/access-rightsGet object access control list
put/v1/objects/{object-id}/access-rightsReplace object access control list
get/v1/objects/{object-id}/pollingGet node polling configuration
patch/v1/objects/{object-id}/pollingUpdate node polling configuration
patch/v1/objects/{object-id}/auto-bindUpdate object auto-bind configuration
get/v1/objects/{object-id}/facilityGet facility configuration
patch/v1/objects/{object-id}/facilityUpdate facility configuration
get/v1/objects/{object-id}/power-domainGet power domain configuration
patch/v1/objects/{object-id}/power-domainUpdate power domain configuration
get/v1/objects/{object-id}/cooling-zoneGet cooling zone configuration
patch/v1/objects/{object-id}/cooling-zoneUpdate cooling zone configuration
get/v1/objects/{object-id}/roomGet room configuration
patch/v1/objects/{object-id}/roomUpdate room configuration
get/v1/objects/{object-id}/room-placementGet room placement of a rack
patch/v1/objects/{object-id}/room-placementUpdate room placement of a rack
get/v1/objects/{object-id}/snmpGet node SNMP communication configuration
patch/v1/objects/{object-id}/snmpUpdate node SNMP communication configuration
get/v1/objects/{object-id}/agentGet node agent communication configuration
patch/v1/objects/{object-id}/agentUpdate node agent communication configuration
get/v1/objects/{object-id}/custom-attributesGet object custom attributes
put/v1/objects/{object-id}/custom-attributes/{name}Create or update a single custom attribute
delete/v1/objects/{object-id}/custom-attributes/{name}Delete a single custom attribute
get/v1/objects/{object-id}/asset-propertiesGet asset properties
put/v1/objects/{object-id}/asset-properties/{name}Create or update a single asset property
delete/v1/objects/{object-id}/asset-properties/{name}Delete a single asset property
get/v1/objects/{object-id}/responsible-usersGet object responsible users
put/v1/objects/{object-id}/responsible-users/{user-id}Add or update a responsible user
delete/v1/objects/{object-id}/responsible-users/{user-id}Remove a responsible user
get/v1/objects/{object-id}/dashboardGet dashboard content
put/v1/objects/{object-id}/dashboardReplace dashboard content
get/v1/objects/{object-id}/mapGet network map content
put/v1/objects/{object-id}/mapReplace network map content
put/v1/objects/{object-id}/dashboardsReplace associated dashboards
put/v1/objects/{object-id}/trusted-objectsReplace trusted objects
get/v1/objects/{object-id}/urlsGet object URLs
post/v1/objects/{object-id}/urlsAdd an object URL
put/v1/objects/{object-id}/urls/{url-id}Update an object URL
delete/v1/objects/{object-id}/urls/{url-id}Delete an object URL
get/v1/objects/{object-id}/childrenGet full details of direct child objects
put/v1/objects/{object-id}/children/{child-id}Bind child object to parent
delete/v1/objects/{object-id}/children/{child-id}Unbind child object from parent
get/v1/objects/{object-id}/device-config-backupsList device configuration backups
get/v1/objects/{object-id}/device-config-backups/{backup-id}Get device configuration backup
post/v1/objects/{object-id}/execute-agent-commandExecute command on agent
post/v1/objects/{object-id}/execute-dashboard-scriptExecute dashboard element script within context of given object
post/v1/objects/{object-id}/execute-scriptExecute script within context of given object
post/v1/objects/{object-id}/expand-textExpand text macros
post/v1/objects/{object-id}/remote-controlCreate Remote Control Session
post/v1/objects/{object-id}/restore-device-configRestore device configuration
post/v1/objects/{object-id}/set-maintenanceMake object enter or leave maintenance mode, immediately or on schedule
post/v1/objects/{object-id}/set-managedManage or unmanage object
post/v1/objects/{object-id}/wake-upSend Wake-on-LAN packet
get/v1/objects/{object-id}/take-screenshotTake screenshot from remote system via NetXMS agent
get/v1/objects/{object-id}/topology/l2Get L2 (link layer) topology
get/v1/objects/{object-id}/topology/ipGet IP topology
get/v1/objects/{object-id}/topology/ospfGet OSPF topology
get/v1/objects/{object-id}/topology/internalGet internal communication topology
get/v1/objects/{object-id}/availabilityGet business service availability
get/v1/objects/{object-id}/business-service-checksGet business service checks
post/v1/objects/{object-id}/business-service-checksCreate business service check
get/v1/objects/{object-id}/business-service-checks/{check-id}Get business service check
delete/v1/objects/{object-id}/business-service-checks/{check-id}Delete business service check
patch/v1/objects/{object-id}/business-service-checks/{check-id}Modify business service check
get/v1/objects/{object-id}/arp-cacheGet node ARP cache
get/v1/objects/{object-id}/routing-tableGet node routing table
get/v1/objects/{object-id}/switch-forwarding-databaseGet switch forwarding database
get/v1/objects/{object-id}/wireless/radiosGet wireless radio interfaces
get/v1/objects/{object-id}/wireless/stationsGet wireless stations
get/v1/objects/{object-id}/status-explanationGet object status explanation
get/v1/objects/{object-id}/chassis-layoutGet chassis layout
get/v1/objects/{object-id}/floor-planGet room floor plan
post/v1/objects/{object-id}/floor-plan/passive-elementsCreate room passive element
delete/v1/objects/{object-id}/floor-plan/passive-elements/{element-id}Delete room passive element
patch/v1/objects/{object-id}/floor-plan/passive-elements/{element-id}Update room passive element
get/v1/objects/{object-id}/rack-layoutGet rack layout
post/v1/objects/{object-id}/rack-layout/passive-elementsCreate rack passive element
delete/v1/objects/{object-id}/rack-layout/passive-elements/{element-id}Delete rack passive element
patch/v1/objects/{object-id}/rack-layout/passive-elements/{element-id}Update rack passive element
get/v1/objects/{object-id}/sub-treeGet object sub-tree
post/v1/objects/queryExecute object query
post/v1/objects/searchSearch objects
post/v1/objects/detailsGet multiple objects
get/v1/script-executions/output/{token}Connect to script output stream (WebSocket)
post/v1/script-executions/{execution-id}/stopStop running script

Persistent Storage4

Scheduled Tasks6

Script Library7

Server8

Server Actions5

Server Console3

SNMP MIB2

SNMP Trap Mappings5

SSH Keys5

TCP Proxy2

Traffic Observers1

Two-Factor Authentication9

User Groups5

Users13

Web Service Definitions5

Objects

Changes to Add an object URL

post/v1/objects/{object-id}/urls

May 30, 2026eb2db2e17897 Revision changes
- info
  endpoint added