/
NE
netxms
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Agent Tunnels
3
AI Chat
7
AI Management
3
AI Memory
5
AI Operators
14
AI Saved Prompts
5
Alarm Categories
5
Alarms
10
Asset Management Schema
5
Authentication
2
Background Tasks
1
Chat Bots
7
Cloud Connectors
1
Data Collection
11
Data Export
4
DCI Summary Tables
7
Event Forwarders
7
Event Processing Policy
8
Event Templates
5
Events
1
Find
2
Geo Areas
5
Grafana
8
Image Library
6
Incidents
10
Log Parsers
2
Logs
5
Mapping Tables
5
Notification Channels
9
Object Categories
5
Object Tools
10
Objects
92
get
/v1/objects
List objects
post
/v1/objects
Create 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}/location
Update object geo location and postal address
patch
/v1/objects/{object-id}/physical-placement
Update object placement in a rack or chassis
patch
/v1/objects/{object-id}/status-calculation
Update object status calculation/propagation parameters
get
/v1/objects/{object-id}/access-rights
Get object access control list
put
/v1/objects/{object-id}/access-rights
Replace object access control list
get
/v1/objects/{object-id}/polling
Get node polling configuration
patch
/v1/objects/{object-id}/polling
Update node polling configuration
patch
/v1/objects/{object-id}/auto-bind
Update object auto-bind configuration
get
/v1/objects/{object-id}/facility
Get facility configuration
patch
/v1/objects/{object-id}/facility
Update facility configuration
get
/v1/objects/{object-id}/power-domain
Get power domain configuration
patch
/v1/objects/{object-id}/power-domain
Update power domain configuration
get
/v1/objects/{object-id}/cooling-zone
Get cooling zone configuration
patch
/v1/objects/{object-id}/cooling-zone
Update cooling zone configuration
get
/v1/objects/{object-id}/room
Get room configuration
patch
/v1/objects/{object-id}/room
Update room configuration
get
/v1/objects/{object-id}/room-placement
Get room placement of a rack
patch
/v1/objects/{object-id}/room-placement
Update room placement of a rack
get
/v1/objects/{object-id}/snmp
Get node SNMP communication configuration
patch
/v1/objects/{object-id}/snmp
Update node SNMP communication configuration
get
/v1/objects/{object-id}/agent
Get node agent communication configuration
patch
/v1/objects/{object-id}/agent
Update node agent communication configuration
get
/v1/objects/{object-id}/custom-attributes
Get 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-properties
Get 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-users
Get 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}/dashboard
Get dashboard content
put
/v1/objects/{object-id}/dashboard
Replace dashboard content
get
/v1/objects/{object-id}/map
Get network map content
put
/v1/objects/{object-id}/map
Replace network map content
put
/v1/objects/{object-id}/dashboards
Replace associated dashboards
put
/v1/objects/{object-id}/trusted-objects
Replace trusted objects
get
/v1/objects/{object-id}/urls
Get object URLs
post
/v1/objects/{object-id}/urls
Add 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}/children
Get 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-backups
List device configuration backups
get
/v1/objects/{object-id}/device-config-backups/{backup-id}
Get device configuration backup
post
/v1/objects/{object-id}/execute-agent-command
Execute command on agent
post
/v1/objects/{object-id}/execute-dashboard-script
Execute dashboard element script within context of given object
post
/v1/objects/{object-id}/execute-script
Execute script within context of given object
post
/v1/objects/{object-id}/expand-text
Expand text macros
post
/v1/objects/{object-id}/remote-control
Create Remote Control Session
post
/v1/objects/{object-id}/restore-device-config
Restore device configuration
post
/v1/objects/{object-id}/set-maintenance
Make object enter or leave maintenance mode, immediately or on schedule
post
/v1/objects/{object-id}/set-managed
Manage or unmanage object
post
/v1/objects/{object-id}/wake-up
Send Wake-on-LAN packet
get
/v1/objects/{object-id}/take-screenshot
Take screenshot from remote system via NetXMS agent
get
/v1/objects/{object-id}/topology/l2
Get L2 (link layer) topology
get
/v1/objects/{object-id}/topology/ip
Get IP topology
get
/v1/objects/{object-id}/topology/ospf
Get OSPF topology
get
/v1/objects/{object-id}/topology/internal
Get internal communication topology
get
/v1/objects/{object-id}/availability
Get business service availability
get
/v1/objects/{object-id}/business-service-checks
Get business service checks
post
/v1/objects/{object-id}/business-service-checks
Create 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-cache
Get node ARP cache
get
/v1/objects/{object-id}/routing-table
Get node routing table
get
/v1/objects/{object-id}/switch-forwarding-database
Get switch forwarding database
get
/v1/objects/{object-id}/wireless/radios
Get wireless radio interfaces
get
/v1/objects/{object-id}/wireless/stations
Get wireless stations
get
/v1/objects/{object-id}/status-explanation
Get object status explanation
get
/v1/objects/{object-id}/chassis-layout
Get chassis layout
get
/v1/objects/{object-id}/floor-plan
Get room floor plan
post
/v1/objects/{object-id}/floor-plan/passive-elements
Create 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-layout
Get rack layout
post
/v1/objects/{object-id}/rack-layout/passive-elements
Create 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-tree
Get object sub-tree
post
/v1/objects/query
Execute object query
post
/v1/objects/search
Search objects
post
/v1/objects/details
Get multiple objects
get
/v1/script-executions/output/{token}
Connect to script output stream (WebSocket)
post
/v1/script-executions/{execution-id}/stop
Stop running script
Persistent Storage
4
Scheduled Tasks
6
Script Library
7
Server
8
Server Actions
5
Server Console
3
SNMP MIB
2
SNMP Trap Mappings
5
SSH Keys
5
TCP Proxy
2
Traffic Observers
1
Two-Factor Authentication
9
User Groups
5
Users
13
Web Service Definitions
5
Objects
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Update an object URL
put
/v1/objects/{object-id}/urls/{url-id}
May 30, 2026
eb2db2e17897
Revision changes
info
endpoint added