List SD-WAN Configs
GET
/ea/sd-wan-configs

Description

Retrieves a list of all SD-WAN configurations associated with the UI account making the API call.
Example 
curl -X GET 'https://api.ui.com/ea/sd-wan-configs' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

Responses

200
ok
data
array
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
httpStatusCode
integer
HTTP status code
traceId
string
Request trace identifier
Example Response 
{
  "data": [
    {
      "id": "9304163b-680d-4de8-a7a0-7617e328911d",
      "name": "SD-WAN test",
      "type": "sdwan-hbsp"
    }
  ],
  "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

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 list network cloud SD-WAN configs
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 list network cloud SD-WAN configs",
  "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"
}