Enrich fields for given objects

Enrich object data in the Nexthink inventory with specific information.

Enrich fields for given objects

post

Enrichment can be done for manual custom fields (any object), virtualization fields (devices only), configuration_tag for devices, the organization field (users only), or the Entra ID fields (users only).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Objects to be enriched (with desired fields and values) and domain (configurable)

domainstring · min: 1Required

Domain for which the given enrichment applies. For information and tracking purposes mainly

Responses

200

Successful enrichment response

application/json

207

Partial success enrichment response - some invalid enrichment, see error codes for details

application/json

400

Bad request - invalid enrichment, see error codes for details

application/json

401

Unauthorized - invalid authentication credentials

403

Forbidden - no permission to trigger enrichment

application/json

post

/api/v1/enrichment/data/fields

HTTPcURLJavaScriptPython

POST /api/v1/enrichment/data/fields HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 773

{
  "enrichments": [
    {
      "identification": [
        {
          "name": "device/device/name",
          "value": "DEVICE-1"
        }
      ],
      "fields": [
        {
          "name": "device/device/virtualization/desktop_pool",
          "value": "Desktop Pool DC1"
        },
        {
          "name": "device/device/virtualization/type",
          "value": 2
        },
        {
          "name": "device/device/virtualization/last_update",
          "value": "2023-10-03T15:00:00.000Z"
        },
        {
          "name": "device/device/#<custom_field_name>",
          "value": "custom_value_1"
        }
      ]
    },
    {
      "identification": [
        {
          "name": "device/device/uid",
          "value": "f9a936fb-6256-4caf-8f59-c6a6b6f620a7"
        }
      ],
      "fields": [
        {
          "name": "device/device/virtualization/desktop_pool",
          "value": "Desktop Pool DC2"
        },
        {
          "name": "device/device/#<custom_field_name>",
          "value": "custom_value_2"
        },
        {
          "name": "device/device/#<another_custom_field_name>",
          "value": "custom_value_3"
        }
      ]
    }
  ],
  "domain": "virtualization_and_custom_fields"
}

Multiple devices, multiple fieldsMultiple users, multiple fieldsMultiple binaries, multiple fieldsMultiple packages, multiple fields

{
  "status": "success"
}