Skip to main content

Data Connectors

Collect data for NQE from HTTP(S) services outside the network.OpenAPI: YAML | JSON

A data connector brings data from an HTTP(S) service outside the network into a network Snapshot, where NQE queries can read it. Use one for data that lives behind an API and changes over time, such as IPAM records, CMDB entries, or asset inventories.

A connector names a baseUrl and one or more endpoints beneath it. Every collection re-fetches every endpoint, so a Snapshot holds whatever the service returned at the time it was collected. Responses in JSON, CSV, and plain text are supported; the content-type response header selects the format. An endpoint whose dataset arrives in pages declares a paginationModel saying how to derive each subsequent request.

A connector can reference an HTTP credential ID to authenticate with and a proxy server ID if one is needed to reach the service.

Collected data appears in the NQE data model under network.dataConnectors. See Data Connectors for the shape of that data, worked pagination examples, and when to prefer a data file over a connector.


Get a network’s data connectors
/api/networks/:networkId/data-connectors
Add a data connector
/api/networks/:networkId/data-connectors
Get a data connector
/api/networks/:networkId/data-connectors/:name
Update a data connector
/api/networks/:networkId/data-connectors/:name
Test a data connector
/api/networks/:networkId/data-connectors/:name?action=test
Delete a data connector
/api/networks/:networkId/data-connectors/:name