Home
N2OS SDK
The N2OS Software Development Kit (SDK).
Data integration best practices
A description of best practices when using Nozomi Networks data integration with Syslog integration or OpenAPI calls.
Nozomi Networks certification
Technical requirements
This reference outlines the technical requirements for integrating with Nozomi Networks, including API authentication, pagination rules, and logging format compliance.

N2OS SDK
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.
  - OpenAPI data
  - Nozomi Networks certification
    - Technical requirements
      This reference outlines the technical requirements for integrating with Nozomi Networks, including API authentication, pagination rules, and logging format compliance.
    - Certify your integration
      Follow this process to certify your integration with Nozomi Networks. Learn how to comply with technical requirements, submit necessary documentation, and complete a demonstration for final approval.

Technical requirements

This reference outlines the technical requirements for integrating with Nozomi Networks, including API authentication, pagination rules, and logging format compliance.

API integrations

The integration must use application programming interface (API)-key based authentication.

Pagination must be used as follows:

For API-based integrations, pagination must be used
For API-based integrations, no more than 10,000 records can be pulled in a single call, and no more than 1,000 records in a single page

Make sure that a maximum parallel requests limit is configured so requests sent to the API is throttled.

An nn-app value-key pair is included in the header:

{
'nn-app': 'your-app-name',
'nn-app-version': '1.0.0'
}

CEF Syslog integrations

Make sure that the custom fields are mapped as necessary for your integration. flexString4 in the common event format (CEF) Syslog can contain multiple field-value pairs.

The Syslog connection can be received with transport layer security (TLS) encryption enabled.

For more details, see Data Integrations > Common Event Format (CEF) in the related Administrator Guide.

Custom JSON integrations

There are no technical requirements for certification.