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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Extreme Networks

Extreme Networks AFC API

ExtremeCloud IQ AFC Feature.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 18 operations across 13 paths, and defines 29 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.

18 operations 13 paths 29 schemas 9 GET7 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
Contact
Extreme Networks Support
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 18

Across 13 paths, the API surfaces 18 operations — 9 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

AFC 18

ExtremeCloud IQ AFC Feature.

GET
/afcserver
Get list of AFC Servers
listAfcServers 1 param → 200default
GET
/afcserver/statistics/{server_id}
Get AFC server Statistics
getAfcServerStatistics 4 params → 200default
GET
/ap/afc/interface/details/{sn}
Get AP Interface status
getAfcApDetails 1 param → 200default
POST
/afc/recalculateSite/{id}
AFC Recalculate Geolocation
recalculateSite 1 param → 200default
POST
/afc/aps/reportFtm
Request FTM data for APs
requestAfcFtmData body → 200default
GET
/afc/aps/status/summary
AFC AP status Summary
getAfcApsStatusSummary → 200default
GET
/floor/afc/details
Get AFC Floor Details
getFloorAfcProperties 2 params → 200
POST
/floor/afc/details
Add AFC Floor Details
addFloorAfcProperties body → 200
PUT
/floor/afc/details
Update AFC Floor Details
updateFloorAfcProperties body → 200
GET
/aps/afc/query
Query AFC APs
getApsAfcSummaryInfo 1 param → 200
POST
/aps/afc/query
Query AFC APs
getApsAfcSummaryInfoWithFilter 1 param body → 200
GET
/ap/afc/diagnostics/{id}
Get AFC AP Diagnostics
getApsAfcDiagnostics 2 params → 200default
GET
/ap/afc/floorReport/{deviceId}
Get AFC Floor Report
getAfcGeolocationFloorReport 1 param → 200
POST
/aps/afc/update
Request Manual Spectrum for device(s)
postApsManualAfcSpectrum body → 200default
GET
/site/afc/schedule
Get AFC Site Schedule
getAfcSiteSchedule 2 params → 200default
POST
/site/afc/schedule
Create AFC Site Schedule
addAfcSiteSchedule body → 200default
PUT
/site/afc/schedule
Update AFC SiteSchedule
updateAfcSiteSchedule body → 200default
POST
/afc/mobileapp/apcandidates
Find potential AP candidates to be used as anchor
afcMobileappApCandidates body → 200default

Schemas 29

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

XiqAfcApDiagnostics
object
AFC AP Diagnostics containing spectrum details
1 property
XiqListAfcServers
object
1 property
XiqAfcSiteScheduleResponse
XiqAfcFloorDetails
object
AFC Floor Details containing floor and AP height information
6 properties
XiqAfcMobileappCoordinates
XiqAfcAvailableSpectrum
object
3 properties
XiqAfcMobileappAnchorCandidate
XiqAfcServerState
string
Status of AFC server connection
XiqGetAfcGeolocationFloorReportResponse
object
Response containing AFC floor report data
1 property 1 required
XiqAfcServersStatistics
XiqAfcServer
object
4 properties
XiqAfcServerStatistics
XiqErrorParams
object
Error parameters
2 properties
XiqAfcMobileappScanInfo
XiqAfcApsInfoElement
object
AFC APs Information Element containing status summaries
4 properties
XiqAvailableChannelInfo
object
3 properties
XiqError
object
6 properties 3 required
XiqAfcApStatus
string
Status of AP AFC.
XiqReportFtmDataRequest
object
2 properties 2 required
XiqMacAddress
string
Colon separated MAC address in upper or lower case
XiqAfcGeolocationSummary
XiqSpectrumMismatchSummary
object
Spectrum Mismatch Summary information
3 properties
XiqAfcStatusSummary
object
AFC Status Summary information
3 properties
XiqAfcApStatusSummary
XiqAfcCoordinatesSource
string
Source of coordinates: APP - Mobile Application GPS coordinates, GPS - AP reported GPS coordinates, GEO - Geolocation Agent derived coordinates
XiqAfcApManualSpectrum
object
Manual spectrum request for AFC AP devices
1 property 1 required
XiqAfcApInterfaceDetails
object
6 properties
XiqMobileappAnchorCandidatesResponse
object
The response for afc mobile app anchor candidates
1 property
XiqAfcSiteSchedule

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-afc-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
AE Profile APIs.io
ExtremeCloud IQ Controller Application Manager API
AE Profile APIs.io
Ansible Network Collection for Extreme EXOS
AE Profile APIs.io
Ansible Network Collection for Extreme VOSS
AE Profile APIs.io
Ansible Network Collection for Extreme SLX-OS
AE Profile APIs.io
Ansible Network Collection for Extreme NOS
AE Profile APIs.io
Ansible Network Collection for Extreme Fabric Engine
AE Profile APIs.io
Extreme Networks Account API
AE Profile APIs.io
Extreme Networks Administration API
AE Profile APIs.io
Extreme Networks Alert API
AE Profile APIs.io
Extreme Networks Application API
AE Profile APIs.io
Extreme Networks Authentication API
AE Profile APIs.io
#AFC
← Back to E APIs
API Details
ID
extreme-networks:extreme-networks-afc-api
Base URL
https://api.extremecloudiq.com
Docs
https://developer.extremecloudiq.com/
Provider
Extreme Networks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network