Home
N2OS SDK
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.
Reports endpoint

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.

Reports endpoint

A GET to /api/open/reports allows you to get a list of all the reports generated.

Requirements and Restrictions

A user having the permission to execute api.
The result contains the list of all the reports.
It's possible to use pagination adding page and count params
The page param is the number of the page to return, the count is the dimension of the page.
If count is nil or 0 the default value will be 100, if page is nil or 0 the request will not be paginated.
You can filter the result passing a template_name as query param having value the report templates name you want filtering on.

Example of reports all request — Figure 1. Example of reports all request

A GET to /api/open/reports/:id allows you to get the report having the id passed as path parameter.

Requirements and Restrictions

A user having the permission to execute api.
As last parameter of the path you need to specify the id of the report.
The result will contain the report.
In case the report with that id is not found you'll get a 404.

Example of reports/:id request — Figure 2. Example of reports/:id request

A GET to /api/open/reports/:id/files allows you to download the report having the id passed as path parameter.

Requirements and Restrictions

A user having the permission to execute api.
As middle parameter of the path you need to specify the id of the report.
The report download will be triggered.
In case the report with that id is not found you'll get a 404.

Example of reports/:id request — Figure 3. Example of reports/:id request

A POST to /api/open/reports allows you to create a new report.

Requirements and Restrictions

A user having the permission to execute api.
You need to pass as query param the report_template_id you want to create.
In case the request is well formed return a 202 response with the id of the job is taking care of teh request.

Example of create report request — Figure 4. Example of create report request

A GET to api/open/reports/jobs/1/status allows you to get the create report job result.

Requirements and Restrictions

A user having the permission to execute api.
As parameter of the path you need to specify the id of the job.
The result will contain the job status

Example of reports/:id request — Figure 5. Example of reports/:id request