How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ubiquiti SD-WAN API

SD-WAN configurations and deployment status

Ubiquiti SD-WAN API is one of 8 APIs that Ubiquiti publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SD-WAN. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

3 operations 3 paths 6 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ui.com/v1
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Ubiquiti SD-WAN API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated at https://unifi.ui.com/settings/api-keys

Paths & Operations 3

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

SD-WAN 3

SD-WAN configurations and deployment status

GET
/ea/sd-wan-configs
List SD-WAN Configs
listSdwanConfigs → 200401429
GET
/ea/sd-wan-configs/{id}
Get SD-WAN Config by ID
getSdwanConfigById 1 param → 200401404429
GET
/ea/sd-wan-configs/{id}/status
Get SD-WAN Config Status
getSdwanConfigStatus 1 param → 200401404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SdwanConfig (5 properties), Envelope (2 properties). Each schema is shown below with its type and property counts.

SdwanConfig
object
5 properties
SdwanConfigStatusResponse
Envelope
object
2 properties 1 required
Error
SdwanConfigResponse
SdwanConfigListResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ubiquiti-sd-wan-api-openapi.yml Raw ↑

Other APIs Ubiquiti publishes across the network.

UniFi Network Controller API
UISP Network (NMS) API
UISP CRM API
Ubiquiti Devices API
Ubiquiti Hosts API
Ubiquiti ISP Metrics API
Ubiquiti Sites API
Where this information came from

This is an independent, third-party profile of Ubiquiti SD-WAN API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.