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 Log API

Access all kinds of logs in ExtremeCloud IQ

Extreme Networks Log 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 Log. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 21 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.

9 operations 9 paths 21 schemas 8 GET1 POST

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 Log API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 8 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Log 9

Access all kinds of logs in ExtremeCloud IQ

GET
/logs/audit
List audit logs
listAuditLogs 9 params → 200default
GET
/logs/audit/full-descriptions/{id}
Get audit log full descriptions
getAuditLogFullDescriptions 1 param → 200default
POST
/logs/audit/reports
Create audit logs report
createAuditLogReport 8 params → 200default
GET
/logs/audit/reports/{id}
Download audit logs
downloadAuditLogs 1 param → 200default
GET
/logs/sms
List SMS logs
listSmsLogs 5 params → 200default
GET
/logs/email
List Email logs
listEmailLogs 5 params → 200default
GET
/logs/auth
List auth logs
listAuthLogs 6 params → 200default
GET
/logs/credential
List credential logs
listCredentialLogs 5 params → 200default
GET
/logs/accounting
List accounting logs
listAccountingLogs 6 params → 200default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are XiqAccountingLog (32 properties), XiqAuthLog (17 properties), XiqAuditLog (11 properties), XiqSmsLog (11 properties). Each schema is shown below with its type and property counts.

PagedXiqEmailLog
XiqSmsLogStatus
string
The SMS status
XiqAuditLogReport
object
ExtremeCloud IQ Audit Log report
1 property
XiqSortOrder
string
XiqSmsLog
object
ExtremeCloud IQ SMS Log
11 properties 1 required
PagedXiqCredentialLog
XiqAuthLog
object
ExtremeCloud IQ Auth Log
17 properties 1 required
XiqAuditLogSortField
string
All fields used to sort the audit logs
XiqAuditLog
object
ExtremeCloud IQ Audit Log
11 properties 1 required
XiqErrorParams
object
Error parameters
2 properties
PagedXiqSmsLog
PagedXiqAuditLog
XiqAuditLogCategory
string
XiqError
object
6 properties 3 required
PagedXiqAuthLog
XiqPage
object
4 properties 4 required
XiqAccountingLog
object
ExtremeCloud IQ Accounting Log
32 properties 1 required
XiqAuditLogFullDescriptions
object
ExtremeCloud IQ Audit Log full descriptions
4 properties 4 required
PagedXiqAccountingLog
XiqEmailLog
object
ExtremeCloud IQ Email Log
8 properties 1 required
XiqCredentialLog
object
ExtremeCloud IQ Credential Log
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-log-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