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 Configuration - Basic API

VLAN Profile/DHCP Server/...

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

This API exposes 5 operations across 2 paths, and defines 14 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.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 PATCH1 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 Configuration - Basic API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 5

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

Configuration - Basic 5

VLAN Profile/DHCP Server/...

GET
/vlan-profiles
List VLAN profiles
listVlanProfiles 2 params → 200default
POST
/vlan-profiles
Create VLAN profile
createVlanProfile body → 201default
GET
/vlan-profiles/{id}
Get a VLAN profile
getVlanProfile 1 param → 200default
PATCH
/vlan-profiles/{id}
Update a VLAN profile
updateVlanProfile 1 param body → 200default
DELETE
/vlan-profiles/{id}
Delete a VLAN profile
deleteVlanProfile 1 param → 200default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), XiqUpdateVlanProfileRequest (4 properties), XiqCreateVlanProfileRequest (4 properties), XiqPage (4 properties). Each schema is shown below with its type and property counts.

PagedXiqVlanProfile
XiqUpdateVlanProfileRequest
object
4 properties 3 required
XiqVlanProfile
XiqError
object
6 properties 3 required
XiqVlanObjectClassifiedEntry
XiqUpdateVlanObjectClassifiedEntryRequest
object
The VLAN object classified entries
2 properties 2 required
XiqClassificationRule
XiqClassificationType
string
Classification type
XiqErrorParams
object
Error parameters
2 properties
XiqPage
object
4 properties 4 required
XiqClassification
XiqBaseEntity
object
3 properties 3 required
XiqCreateVlanObjectClassifiedEntryRequest
object
The VLAN object classified entries
2 properties 2 required
XiqCreateVlanProfileRequest
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-configuration-basic-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