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

Push configuration to devices

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

This API exposes 9 operations across 6 paths, and defines 18 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 6 paths 18 schemas 1 DELETE5 GET2 POST1 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 Configuration - Deployment 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 6 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration - Deployment 9

Push configuration to devices

POST
/deployments
[LRO] Push configuration and upgrade firmware
deployConfig 1 param body → 200default
GET
/deployments
Get list of deployments
getFirmwareUpgradeDetails 2 params → 200default
GET
/deployments/overview
Get configuration deployment overview
getDeployOverview → 200default
GET
/deployments/status
Get configuration deployment status
getDeployStatus 1 param → 200default
POST
/deployments/firmware-metadatas
Get device firmware metadatas
getDeviceFirmwareMetadatas body → 200default
PUT
/deployments/{deploymentId}
Update schedule with deployment ID
updateFirmwareUpgrade 1 param body → 200default
GET
/deployments/{deploymentId}
Get details of the deployment by deployment ID
getFirmwareUpgradeScheduleDetails 1 param → 200default
DELETE
/deployments/{deploymentId}
Delete the deployment schedule by ID
deleteFirmwareUpgradeSchedule 1 param → 200default
GET
/deployments/{deploymentId}/status
[LRO] Get firmware deployment status by ID
getFirmwareUpgradeScheduleStatus 2 params → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are XiqDeviceFirmwareMetadata (12 properties), XiqDeploymentStatus (7 properties), XiqDeploymentScheduleStatusResponse (7 properties), XiqError (6 properties). Each schema is shown below with its type and property counts.

XiqScheduleDetails
object
The deployment schedule details
1 property 1 required
XiqDeploymentPolicy
object
Push configuration and upgrade firmware policy
4 properties
XiqDeploymentDetailsResponse
object
The deployment details
5 properties
XiqDeploymentResponse
object
The configuration deployment response
2 properties
XiqErrorParams
object
Error parameters
2 properties
XiqScheduleStatus
string
XiqDeploymentOverviewDetails
object
The configuration deployment overview
3 properties 3 required
XiqDeploymentOverview
object
The configuration deployment overview
2 properties 2 required
XiqError
object
6 properties 3 required
XiqDeploymentStatus
object
The configuration deployment status
7 properties
XiqPage
object
4 properties 4 required
XiqFirmwareUpgradeVersion
object
Upgrade to the specific firmware version
3 properties 3 required
XiqFirmwareActivateOption
object
The firmware activate option (Only one of them can be enabled)
3 properties
XiqDeployDeviceFilter
object
The filter to get matched devices
2 properties
XiqDeviceFirmwareMetadata
object
The device compatible firmware metadata
12 properties
XiqFirmwareUpgradePolicy
object
The firmware upgrade policy
2 properties 2 required
XiqDeploymentScheduleStatusResponse
object
The status of the firmware upgrade sites/devices
7 properties
XiqDeploymentRequest
object
The configuration deployment request to devices
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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