Sign in

v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB
Objects

Update common object properties

Update common scalar properties on any NetObj. Request body uses JSON merge-patch semantics (RFC 7396) — fields present in the body are updated, fields omitted are left untouched, and explicit null clears the field. Returns the updated object in the same shape as GET /v1/objects/{object-id}. Class-specific property groups (snmp, agent, polling, etc.) are exposed as separate sub-resources.

patch/v1/objects/{object-id}

Path parameters

object-idinteger required

Request body

namestring

Object name (control characters are replaced with spaces).

aliasstring nullable

Object alias. null or empty string clears the alias.

nameOnMapstring nullable

Display name used on network maps. null clears the override.

commentsstring nullable

Free-form object comments. null or empty string clears them.

categoryinteger nullable

Object category ID. null or 0 clears the category.

mapImagestring uuid nullable

Image library UUID for the object on maps. null clears the image.

drilldownObjectIdinteger nullable

ID of the object opened on drill-down. null or 0 clears the link.

macAddressstring

Interface only. MAC address in any accepted textual notation. Allowed only for manually created interfaces; rejected otherwise.

requiredPollCountinteger

Interface only. Number of consecutive polls required to change status.

expectedStateinteger

Interface only. Expected interface state (0 = UP, 1 = DOWN, 2 = IGNORE, 3 = AUTO).

peerinteger nullable

Interface only. ID of the peer interface to link to. Establishes a manual bidirectional peer link (any previous peer on either side is cleared) and requires modify access on the peer interface. null or 0 clears the current peer.

Response

Object updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8