Home
Resources
N2OS Software Development Kit
The N2OS Software Development Kit (SDK).
OpenAPI
The scriptable variables correlation feature allows users to implement custom checks on the way variable values change over time. This section covers how such scripts can be implemented and used.
OpenAPI

Resources
- Release Notes
  Access the release notes for release-based products.
- N2OS Configuration
  The N2OS Configuration - Reference Guide.
- N2OS Software Development Kit
  The N2OS Software Development Kit (SDK).
  - Scriptable protocols
    The Lua scripting API for building a custom protocol decoder.
  - Scriptable variables
    The scriptable variables correlation feature allows users to implement custom checks on the way variable values change over time. This section covers how such scripts can be implemented and used.
  - OpenAPI
    The scriptable variables correlation feature allows users to implement custom checks on the way variable values change over time. This section covers how such scripts can be implemented and used.
  - Data model reference
    The data model reference for query entities.
  - Data integration best practices
    A description of best practices when using Nozomi Networks data integration with Syslog integration or OpenAPI calls.
- Integration Guides
  Integration guides to help you use applications that integrate with Nozomi Networks products.
- Reference Guides
  Additional reference guides with information on items such as Alerts and Incidents and Federal Information Processing Standards (FIPS).
- Quick Start Guides
  Hardware Quick Start Guides.
- Security
  Stay up-to-date with the most recent information and solutions for all vulnerabilities that affect Nozomi Networks products.
- Print format documentation
  A list of all the technical documentation that is available in print format.
- Documentation archive
  Access previous versions of the technical documentation.

OpenAPI

This section describes OpenAPI implementation, which consists of a Hypertext Transfer Protocol (HTTP) endpoint for executing custom queries.

Important: Queries and exports permission is needed to query all OpenAPI endpoints. In addition, there are further Role-Based Access Control (RBAC) permissions that restrict application programming interface (API) queries to specific tables.

OpenAPI methods that change sensor data produce audit logs. For example, this happens when a new user is added through OpenAPI or when an alert is acknowledged. By default, read-only operations do not produce audit logs. It is possible to change this behavior and have GET OpenAPI methods produce audit logs by specifying the following command-line interface (CLI) command:

conf.user configure open_api audit get enabled true