Skip to main content

Checks

Enable or define automated checks that verify network policy and behavior.OpenAPI: YAML | JSON

Checks (or Verifications) verify network policy and behavior. They cover security, reachability, fault tolerance, and compliance and can help network operators prevent regressions and confirm that desired end-to-end behavior holds as the network evolves.

There are 5 main types of checks:

  • NQE (Network Query Engine) checks are a library of common or custom queries for consistency or policy violations.
  • Predefined checks are a library of common checks which apply to typical network designs.
  • Existence intent checks verify that specific traffic is allowed between one or more points within the network.
  • Isolation intent checks verify that specific traffic is prohibited between one or more points within the network.
  • Reachability intent checks verify that specific traffic gets delivered to its intended destination.

When a new check is added to a Snapshot, its result is immediately evaluated for that Snapshot. Check creation and deletion propagate forward to later Snapshots of the network, just like Aliases.

Get available Predefined checks
/api/predefinedChecks
Get checks (with status)
/api/snapshots/:snapshotId/checks
Add a check
/api/snapshots/:snapshotId/checks
Deactivate all checks
/api/snapshots/:snapshotId/checks
Get a check (with status)
/api/snapshots/:snapshotId/checks/:checkId
Deactivate a check
/api/snapshots/:snapshotId/checks/:checkId