Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks NG Scheduled Reports API

The NG Reports - Scheduled Reporting

Extreme Networks NG Scheduled Reports API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NG Scheduled Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

15 operations 10 paths 15 schemas 2 DELETE8 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks NG Scheduled Reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 2 DELETE, 8 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

NG Scheduled Reports 15

The NG Reports - Scheduled Reporting

GET
/ng-reports/scheduled/network-summary
Get Scheduled Network Summary Reports
getScheduledNetworkSummaryReports 1 param → 200default
GET
/ng-reports/scheduled/pci-compliance
Get Scheduled PCI Compliance Reports
getScheduledPciComplianceReports 1 param → 200default
PATCH
/ng-reports/scheduled/{reportScheduleId}
Enable/Disable Report Schedule
patchReportSchedule 2 params → 200default
GET
/ng-reports/scheduled/custom
Get Scheduled Custom Reports
getScheduledCustomReports 4 params → 200default
POST
/ng-reports/scheduled/custom
Create Schedule for Custom Report
createCustomReportSchedule body → 200default
DELETE
/ng-reports/scheduled/custom
Delete Report Schedules
deleteReportSchedule 1 param → 200default
GET
/ng-reports/scheduled/custom/{reportId}
Get Custom Report Schedule by ID
getScheduledCustomReportById 1 param → 200default
PUT
/ng-reports/scheduled/custom/{reportId}
Edit Schedule for Custom Report
updateCustomReportSchedule 1 param body → 200default
GET
/ng-reports/scheduled/custom/{reportScheduleId}/runs
Get Report Runs for Custom Report Schedule
getCustomReportRuns 2 params → 200default
DELETE
/ng-reports/scheduled/runs
Delete Report Runs
deleteCustomReportRun 1 param → 200default
GET
/ng-reports/scheduled/runs/{reportRunId}/recipients
Get Recipients for given Report Run
getReportRunRecipients 2 params → 200default
GET
/ng-reports/scheduled/{reportId}/recipients
Get Recipients for given Report
getReportRecipients 2 params → 200default
PUT
/ng-reports/scheduled/{reportId}/recipients
Add Recipients to Report
addRecipientsToReport 1 param body → 200default
POST
/ng-reports/scheduled/{reportId}/recipients
Delete Recipients from Report
deleteRecipientsFromReport 1 param body → 200default
GET
/ng-reports/scheduled/reports/download
Download or Preview Scheduled Report File
downloadScheduledReportFile 3 params → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are XiqCustomReportScheduleResponse (12 properties), XiqCreateCustomReportScheduleRequest (11 properties), XiqUpdateCustomReportScheduleRequest (11 properties), XiqCustomScheduledReport (7 properties). Each schema is shown below with its type and property counts.

XiqCustomScheduledReport
object
7 properties
XiqReportRecipient
object
3 properties
XiqScheduleFrequencyRequest
object
5 properties
XiqError
object
6 properties 3 required
XiqReportRunRecipient
object
4 properties
XiqReportRun
object
4 properties
XiqCustomReportScheduleResponse
object
12 properties
XiqErrorParams
object
Error parameters
2 properties
XiqUpdateCustomReportScheduleRequest
object
11 properties
PagedCustomScheduledReport
XiqPage
object
4 properties 4 required
XiqReportMetrics
string
Metrics Type.
XiqScheduledReport
object
4 properties
XiqCreateCustomReportScheduleRequest
object
11 properties
XiqScheduleFrequencyResponse
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-ng-scheduled-reports-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API