Get SD-WAN Config by ID
GET
/ea/sd-wan-configs/{id}

Description

Retrieves detailed information about a specific SD-WAN configuration by ID.

Parameters

id
string
Required
path
Unique identifier of the SD-WAN configuration
Example 
curl -X GET 'https://api.ui.com/ea/sd-wan-configs/{id}' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

Responses

200
ok
data
object
Generic response data, specific schema depends on the endpoint
id
string
Unique identifier of the SD-WAN config
name
string
Name of the SD-WAN config
type
string
Type of SD-WAN config - Currently only supports sdwan-hbsp
Values:
sdwan-hbsp
variant
string
Variant of SD-WAN configuration
Values:
distributed
failover
single
settings
object
Advanced settings
hubsInterconnect
boolean
spokeToHubTunnelsMode
string
Values:
maxResiliency
redundant
scalable
spokesAutoScaleAndNatEnabled
boolean
Auto-assigns subnet and routes; otherwise, users enter them manually.
spokesAutoScaleAndNatRange
string
Subnet in CIDR format, Example: 172.16.0.0/12
spokesIsolate
boolean
Setting for NET: Spokes can reach hubs but not other spokes.
spokeStandardSettingsEnabled
boolean
Enable spoke standard settings
spokeStandardSettingsValues
object
Spoke standard settings
primaryWan
string
Example: ‘WAN’
wanFailover
boolean
Use fail over WAN.
spokeToHubRouting
string
Values:
custom
geo
hubs
array
id
string
hostId
string
siteId
string
networkIds
array[string]
Ids of networks belonging to the hub
routes
array[string]
Subnets in CIDR format: 10.0.0.0/24
primaryWan
string
Example: ‘WAN’
wanFailover
boolean
Use fail over WAN.
spokes
array
id
string
hostId
string
siteId
string
networkIds
array[string]
Ids of networks belonging to the spoke
routes
array[string]
Subnets in CIDR format: 10.0.0.0/24
primaryWan
string
Example: ‘WAN’
wanFailover
boolean
Use fail over WAN.
hubsPriority
array[string]
Non-null for distributed topology and spokeToHubRouting=custom
httpStatusCode
integer
HTTP status code
traceId
string
Request trace identifier
Example Response 
{
  "data": {
    "id": "b344034f-2636-478c-8c7a-e3350f8ed37a",
    "name": "RS test",
    "type": "sdwan-hbsp",
    "variant": "single",
    "settings": {
      "hubsInterconnect": null,
      "spokeToHubTunnelsMode": "scalable",
      "spokesAutoScaleAndNatEnabled": true,
      "spokesAutoScaleAndNatRange": "172.16.0.0/12",
      "spokesIsolate": true,
      "spokeStandardSettingsEnabled": false,
      "spokeStandardSettingsValues": null,
      "spokeToHubRouting": "geo"
    },
    "hubs": [
      {
        "id": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866",
        "hostId": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894",
        "siteId": "670d14b2b4e979611b761866",
        "networkIds": [
          "670d14deb4e979611b761880"
        ],
        "routes": [],
        "primaryWan": "WAN",
        "wanFailover": false
      }
    ],
    "spokes": [
      {
        "id": "28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649_670d153bf6db0d4204f8d150",
        "hostId": "28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649",
        "siteId": "670d153bf6db0d4204f8d150",
        "networkIds": [],
        "routes": [
          "172.16.1.0/24"
        ],
        "primaryWan": "WAN",
        "wanFailover": false,
        "hubsPriority": null
      },
      {
        "id": "F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230_66b5f02af5521234f6f28a23",
        "hostId": "F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230",
        "siteId": "66b5f02af5521234f6f28a23",
        "networkIds": [],
        "routes": [
          "172.16.2.0/24"
        ],
        "primaryWan": "WAN",
        "wanFailover": false,
        "hubsPriority": null
      }
    ]
  },
  "httpStatusCode": 200,
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}

Responses

401
unauthorized
code
Error code from upstream
httpStatusCode
integer
HTTP status code
message
string
Error message
traceId
string
Request trace identifier
Example Response 
{
  "code": "unauthorized",
  "httpStatusCode": 401,
  "message": "unauthorized",
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}

Responses

404
config not found
code
Error code from upstream
httpStatusCode
integer
HTTP status code
message
string
Error message
traceId
string
Request trace identifier
Example Response 
{
  "code": "not_found",
  "httpStatusCode": 404,
  "message": "config not found",
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}

Responses

429
rate limit
code
Error code from upstream
httpStatusCode
integer
HTTP status code
message
string
Error message
traceId
string
Request trace identifier

Headers

Retry-After
string
example: 5
Example Response 
{
  "code": "rate_limit",
  "httpStatusCode": 429,
  "message": "rate limit exceeded, retry after 5.372786998s",
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}

Responses

500
failed to get network cloud SD-WAN config by ID
code
Error code from upstream
httpStatusCode
integer
HTTP status code
message
string
Error message
traceId
string
Request trace identifier
Example Response 
{
  "code": "server_error",
  "httpStatusCode": 500,
  "message": "failed to get network cloud SD-WAN config by ID",
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}

Responses

502
bad gateway
code
Error code from upstream
httpStatusCode
integer
HTTP status code
message
string
Error message
traceId
string
Request trace identifier
Example Response 
{
  "code": "bad_gateway",
  "httpStatusCode": 502,
  "message": "bad gateway",
  "traceId": "a7dc15e0eb4527142d7823515b15f87d"
}