NEnetxms
Objects

Update common object properties

Changed on

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.

Requires modify access to the object. A user holding only the "edit comments" access right may send a patch document containing comments as its only property.

patch/v1/objects/{object-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}
  • Auth
    HTTP bearer

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.

timeZonestring nullable

IANA time zone name, for example Europe/Riga. The time zone is inheritable: when set on a container it applies to all objects within it unless they define their own. null or empty string removes the object's own setting, so the zone inherited from parent objects (if any) applies again. Without timeZoneRule the server resolves the name using its system time zone database; if that is not possible (no zoneinfo database, for example on Windows servers), the request is rejected with 400.

timeZoneRulestring nullable

Optional POSIX TZ rule for timeZone, for example EET-2EEST,M3.5.0/3,M10.5.0/4. When supplied it is validated and used as is instead of resolving the name. Ignored without timeZone.

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.

primaryNamestring

Node only. Primary host name, either a DNS name or a literal IP address. The node's primary IP address is derived from it and is updated by the forced configuration poll that a change schedules — it is not settable on its own. If the name resolves to an address that does not belong to any of the node's interfaces, that address must not already be used by another node or subnet (this check is skipped for an external gateway). A name that does not resolve is accepted.

controllerIdinteger nullable

Chassis only. ID of the node that manages the chassis. This is separate from physicalPlacement: it says which node controls the chassis, not where the chassis is placed. null or 0 clears the controller and unbinds the chassis from it. A non-zero value is rejected with 400 if it does not resolve to an existing node, and with 409 if that node is a descendant of the chassis, which would create a loop.

widthinteger

Rack only. External cabinet width in millimetres.

depthinteger

Rack only. External cabinet depth in millimetres.

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' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | '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

timeZonestring nullable

Effective IANA time zone name (own or inherited from a parent object), null if not set.

timeZoneRulestring nullable

POSIX TZ rule of the effective time zone, null if not set.

timeZoneSourceinteger

ID of the parent object the time zone is inherited from, or 0 when the time zone is defined on this object or not set.

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

Changes

  • 23131ad28171Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 53fbfac7f424Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status