Sign in
Data Collection

Update data collection item

Apply a JSON merge-patch to an existing data collection item: only the properties present in the request body are changed. The thresholds array (and, for table DCIs, the columns array), when present, replaces the whole set; existing thresholds are matched by id so their runtime state is preserved. The type property, if supplied, must match the existing DCI type - it cannot be changed.

patch/v1/objects/{object-id}/data-collection/configuration/{dci-id}

Path parameters

object-idinteger required

Object ID

dci-idinteger required

Data collection item ID

Request body

idinteger

DCI ID (assigned by the server)

guidstring uuid

Globally unique DCI identifier

type'item' | 'table'

DCI type. Selected at creation; cannot be changed afterwards.

namestring

Metric/parameter name (required on create)

descriptionstring

Human-readable DCI description

origin'internal' | 'nxagent' | 'snmp' | 'websvc' | 'push' | 'winperf' | 'smclp' | 'script' | 'ssh' | 'mqtt' | 'driver' | 'modbus' | 'ethernetip' | 'cloud' | 'otlp' | 'trafficobserver' | 'netconf' | 'computed'

Data origin

status'active' | 'disabled' | 'unsupported'

DCI status

dataType'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64'

Data type (single-value DCI only)

transformedDataType'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64'

Data type after transformation (single-value DCI only)

deltaCalculation'none' | 'simple' | 'averagePerSecond' | 'averagePerMinute'

Delta calculation method (single-value DCI only)

pollingScheduleType'default' | 'custom' | 'advanced'

Polling schedule type

pollingIntervalstring

Polling interval expression (used when pollingScheduleType is custom)

retentionType'default' | 'custom' | 'none'

Data retention type

retentionTimestring

Retention time expression (used when retentionType is custom)

systemTagstring
userTagstring
commentsstring
transformationScriptstring

NXSL transformation script source

sourceNodeinteger

Source (proxy) node ID, or 0 to disable

snmpPortinteger
snmpVersioninteger
snmpContextstring
snmpAgentNamestring

Name of additional SNMP agent on the node to collect from; empty to use the node's primary SNMP agent. When set, the agent's configuration takes precedence over snmpPort, snmpVersion, and snmpContext.

snmpRawValueType'none' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'double' | 'ipAddr' | 'macAddr' | 'ip6Addr'

SNMP raw value interpretation (single-value DCI only)

multiplierinteger
unitNamestring
mappingTableIdinteger
sampleCountinteger
predictionEnginestring
allThresholdsRearmEventinteger
aiHintstring
aggregationDisabledboolean
hourlyRetentioninteger
dailyRetentioninteger
instanceDiscoveryMethod'none' | 'agentList' | 'agentTable' | 'snmpWalkValues' | 'snmpWalkOids' | 'script' | 'winperf' | 'webService' | 'internalTable' | 'smclpTargets' | 'smclpProperties' | 'push' | 'otlp'
instanceDiscoveryDatastring
instanceFilterstring

NXSL instance filter script source

instanceNamestring
instanceRetentionTimeinteger
perfTabSettingsstring
accessListinteger[]

Per-DCI access list (user/group IDs)

templateIdinteger
templateItemIdinteger

Response

Data collection item updated

idinteger

DCI ID (assigned by the server)

guidstring uuid

Globally unique DCI identifier

type'item' | 'table'

DCI type. Selected at creation; cannot be changed afterwards.

namestring

Metric/parameter name (required on create)

descriptionstring

Human-readable DCI description

origin'internal' | 'nxagent' | 'snmp' | 'websvc' | 'push' | 'winperf' | 'smclp' | 'script' | 'ssh' | 'mqtt' | 'driver' | 'modbus' | 'ethernetip' | 'cloud' | 'otlp' | 'trafficobserver' | 'netconf' | 'computed'

Data origin

status'active' | 'disabled' | 'unsupported'

DCI status

dataType'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64'

Data type (single-value DCI only)

transformedDataType'int32' | 'uint32' | 'int64' | 'uint64' | 'string' | 'float' | 'null' | 'counter32' | 'counter64'

Data type after transformation (single-value DCI only)

deltaCalculation'none' | 'simple' | 'averagePerSecond' | 'averagePerMinute'

Delta calculation method (single-value DCI only)

pollingScheduleType'default' | 'custom' | 'advanced'

Polling schedule type

pollingIntervalstring

Polling interval expression (used when pollingScheduleType is custom)

retentionType'default' | 'custom' | 'none'

Data retention type

retentionTimestring

Retention time expression (used when retentionType is custom)

systemTagstring
userTagstring
commentsstring
transformationScriptstring

NXSL transformation script source

sourceNodeinteger

Source (proxy) node ID, or 0 to disable

snmpPortinteger
snmpVersioninteger
snmpContextstring
snmpAgentNamestring

Name of additional SNMP agent on the node to collect from; empty to use the node's primary SNMP agent. When set, the agent's configuration takes precedence over snmpPort, snmpVersion, and snmpContext.

snmpRawValueType'none' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'double' | 'ipAddr' | 'macAddr' | 'ip6Addr'

SNMP raw value interpretation (single-value DCI only)

multiplierinteger
unitNamestring
mappingTableIdinteger
sampleCountinteger
predictionEnginestring
allThresholdsRearmEventinteger
aiHintstring
aggregationDisabledboolean
hourlyRetentioninteger
dailyRetentioninteger
instanceDiscoveryMethod'none' | 'agentList' | 'agentTable' | 'snmpWalkValues' | 'snmpWalkOids' | 'script' | 'winperf' | 'webService' | 'internalTable' | 'smclpTargets' | 'smclpProperties' | 'push' | 'otlp'
instanceDiscoveryDatastring
instanceFilterstring

NXSL instance filter script source

instanceNamestring
instanceRetentionTimeinteger
perfTabSettingsstring
accessListinteger[]

Per-DCI access list (user/group IDs)

templateIdinteger
templateItemIdinteger

Changes

Changed in 8 of the 115 revisions of this API.4814

  • 13e5dc345df12See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 15170fcce6772See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fd66f32833f2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 32ce0e24310f33See the full diff
    • ●

      added the new computed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new netconf enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new trafficobserver enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new computed enum value to the request property

      request-property-enum-value-added

    • ○

      added the new netconf enum value to the request property

      request-property-enum-value-added

    • ○

      added the new trafficobserver enum value to the request property

      request-property-enum-value-added

  • c2492179ed1833See the full diff
    • ▲

      removed the enum value computed of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value netconf of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value trafficobserver of the request property

      request-property-enum-value-removed

    • ○

      removed the computed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the netconf enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the trafficobserver enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3aeada4e28f833See the full diff
    • ●

      added the new computed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new netconf enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new trafficobserver enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new computed enum value to the request property

      request-property-enum-value-added

    • ○

      added the new netconf enum value to the request property

      request-property-enum-value-added

    • ○

      added the new trafficobserver enum value to the request property

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0ba24e556c251See the full diff
    • ○

      endpoint added

      endpoint-added

  • c6aaf3632e481See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog