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.
Throttling policy

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.

Throttling policy

Overview

Throttling has been implemented in the HTTP OpenAPI to ensure fair usage and to maintain system stability. When the rate limit is exceeded, the application programming interface (API) responds with a 429 Too Many Requests status code along with the retry-after header indicating the number of seconds the client should wait before retrying the request.

Rate limit

The rate limit for API requests is set to 60 requests per minute. If this limit is exceeded, further requests within the same minute will be rejected with a 429 Too Many Requests response.

Note: The computation of the number of requests is not precise as the requests are counted based on a 1 minute time window starting from the next minute. That means that more than 60 requests might be needed to get the

429 - Too Many
          Requests

error.

Retry-after header

After receiving a 429 Too Many Requests response, clients should parse the retry-after header to determine the waiting period before making another request. This header indicates the number of seconds the client must wait before retrying the request. Clients should respect this waiting period to avoid further throttling.

Impact

Throttling affects all endpoints exposed under the /api/open path. Clients making requests to any of these endpoints should be aware of the throttling policy and handle a 429 Too Many Requests response appropriately.

Example

HTTP/1.1 429 Too Many Requests
Content-Type: application/json
retry-after: 30