Skip to main content

NQE

Ask the Network Query Engine for structured, vendor-agnostic network information.OpenAPI: YAML | JSON

Network Query Engine (NQE) enables you to query for information about your network. For more information about NQE queries and for help writing queries, see the NQE tutorial or the Data Model tab of the Help pane in the NQE Library.

The NQE APIs allow you to run NQE queries on a network Snapshot. There are two ways to run a query:

  • Synchronously via Run an NQE Query, which blocks while the query executes. This single-request workflow is convenient for queries that complete quickly.
  • Asynchronously via Request an NQE query execution, which submits a query for execution and returns an executionKey. You then poll for status and fetch the result separately. This multi-request workflow is suited to long-running queries.
Run an NQE query
/api/nqe
Request an NQE query execution
/api/networks/:networkId/nqe-executions
Get NQE query execution status
/api/networks/:networkId/nqe-executions/:executionKey
Get NQE query execution result
/api/networks/:networkId/nqe-executions/:executionKey/result
Compare NQE query results
/api/nqe-diffs/:before/:after
List all NQE queries
/api/nqe/queries