NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Telemetry

Description

Allows users to access reports in NEO

Request URL

/neo/reports

Main Operations

  • Create Report

  • Save Report

  • Get Report

  • Get All Saved Reports

  • Delete Report

Description

Creates a report in NEO

Request URL

POST /neo/app/reports

Response

HTTP Response Location Header will contain URI with Job ID for creating report. If report was created successfully, a report ID will be returned in Job summary.

Response:

Copy
Copied!
            

{ "object_type": <”Group” | ”System” | ”NetworkPort”>, "objects":{"<system_IP>": [“Eth1/1”, “Eth1/2”, …], …}, "counters":["<counter_name>", …], "tz":"Asia/Jerusalem", "interval":"hour" }

Warning
  • In case the object_type is "NetworkPort", the user will send a list of system ports. Otherwise, an empty list will be sent.

  • There are four available counters to select in reports: InOctetsRate, OutOctetsRate, NormalizedBandwidth, and NormalizedCongestedBandwidth.

Description

This interface is used to save a created report. Saving a report is done by setting a title and a description for the specified report-ID in update request

Request URL

PUT /neo/app/reports/<report_ID>

Request Data

{ 
    "title":"<report_title>", 
    "description":"<report_description>"} 
 }

Response

N/A

Status Codes

Note: status code 403 FORBIDDEN measn the specified Report ID was already saved

Warning

Reports can be saved only once!

Description

TRetrieves report info and data.

Request URL

GET /neo/app/reports/<report_ID>

Request Data

N/A

Response:

Copy
Copied!
            

{ "tz": "Asia/Jerusalem", "description": "", "title": "<report_title>", "report-id": "<Report_ID>", "createdOn": "<date_time>", "interval": "hour", "owner": "<user_name>", "data": "<report_data_objects_list>"  }

Description

Retrieves all reports (only saved reports) info

Request URL

GET /neo/app/reports

Request Data

N/A

Response:

Copy
Copied!
            

[ { "tz": "GMT", "description": "", "title": "<report_title>", "report-id": "<Report_ID>", "createdOn": "<date_time>", "interval": "hour", "owner": "<user_name>" }, … ]

Warning

This interface result will not contain reports data, only reports info.

Description

Removes an existing report from NEO

Request URL

DELETE /neo/app/reports/<report_ID>

Request Data

N/A

Response

N/A

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.