Get SD-WAN Config Status
GET
/ea/sd-wan-configs/{id}/status
Description
Retrieves the status of a specific SD-WAN configuration, including deployment progress, errors, and associated hubs.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}/status' \
-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 configuration
fingerprint
string
A unique identifier representing the current state of the configuration.
updatedAt
integer
int64
The timestamp of the last update to the SD-WAN configuration.
hubs
array
List of hubs in SD-WAN configuration
id
string
Unique identifier of the hub
hostId
string
siteId
string
name
string
primaryWanStatus
object
ip
string
IP format: 10.0.0.1
latency
number
double
internetIssues
array
If WAN experience issues
wanId
string
secondaryWanStatus
object
ip
string
IP format: 10.0.0.1
latency
number
double
internetIssues
array
If WAN experience issues
wanId
string
errors
array
warnings
array
numberOfTunnelsUsedByOtherFeatures
integer
networks
array
networkId
string
name
string
errors
array
warnings
array
routes
array
routeValue
string
subnet in CIDR format: 10.0.0.0/24
errors
array
warnings
array
applyStatus
string
The current status of the hub configuration application.
Values:
ok
creating
updating
removing
createFailed
updateFailed
removeFailed
spokes
array
A list of spokes associated with the SD-WAN config.
id
string
hostId
string
siteId
string
name
string
primaryWanStatus
object
ip
string
IP format: 10.0.0.1
latency
number
double
internetIssues
array
If WAN experience issues
wanId
string
secondaryWanStatus
object
ip
string
IP format: 10.0.0.1
latency
number
double
internetIssues
array
If WAN experience issues
wanId
string
errors
array
warnings
array
numberOfTunnelsUsedByOtherFeatures
integer
networks
array
networkId
string
name
string
errors
array
A list of error messages related to the network, if any.
warnings
array
A list of warning messages related to the network, if any.
routes
array
routeValue
string
subnet in CIDR format: 10.0.0.0/24
errors
array
warnings
array
connections
array
hubId
string
tunnels
array
spokeWanId
string
hubWanId
string
status
string
The current status of the tunnel connection.
Values:
connected
disconnected
pending
applyStatus
string
The current status of the hub configuration application.
Values:
ok
creating
updating
removing
createFailed
updateFailed
removeFailed
lastGeneratedAt
integer
int64
The timestamp of the last generation of the SD-WAN configuration.
generateStatus
string
The status of the configuration generation process.
Values:
OK
GENERATING
GENERATE_FAILED
errors
array
A list of error messages related to the configuration, if any.
warnings
array
A list of warning messages related to the configuration, if any.
httpStatusCode
integer
HTTP status code
traceId
string
Request trace identifier
Example Response
{
"data": {
"id": "",
"fingerprint": "85d521a1b3c8992f",
"updatedAt": 1739454923342,
"hubs": [
{
"id": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866",
"hostId": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894",
"siteId": "670d14b2b4e979611b761866",
"name": "Marlind's UDM SE",
"primaryWanStatus": {
"ip": "194.22.30.166",
"latency": 1,
"internetIssues": [],
"wanId": "WAN"
},
"secondaryWanStatus": {
"ip": "",
"latency": null,
"internetIssues": null,
"wanId": ""
},
"errors": [],
"warnings": [],
"numberOfTunnelsUsedByOtherFeatures": 0,
"networks": [
{
"networkId": "670d14deb4e979611b761880",
"name": "Default",
"errors": [],
"warnings": []
}
],
"routes": [],
"applyStatus": "OK"
}
],
"spokes": [
{
"id": "28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649_670d153bf6db0d4204f8d150",
"hostId": "28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649",
"siteId": "670d153bf6db0d4204f8d150",
"name": "Marlind's UDR",
"primaryWanStatus": {
"ip": "10.0.1.142",
"latency": 1,
"internetIssues": [],
"wanId": "WAN"
},
"secondaryWanStatus": {
"ip": "",
"latency": null,
"internetIssues": null,
"wanId": ""
},
"errors": [],
"warnings": [],
"numberOfTunnelsUsedByOtherFeatures": 0,
"networks": [],
"routes": [
{
"routeValue": "172.16.1.0/24",
"errors": [],
"warnings": []
}
],
"connections": [
{
"hubId": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866",
"tunnels": [
{
"spokeWanId": "WAN",
"hubWanId": "WAN",
"status": "connected"
}
]
}
],
"applyStatus": "OK"
},
{
"id": "F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230_66b5f02af5521234f6f28a23",
"hostId": "F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230",
"siteId": "66b5f02af5521234f6f28a23",
"name": "AG UCG Ultra STG",
"primaryWanStatus": {
"ip": "10.35.87.53",
"latency": 2,
"internetIssues": [],
"wanId": "WAN"
},
"secondaryWanStatus": {
"ip": "",
"latency": null,
"internetIssues": null,
"wanId": ""
},
"errors": [],
"warnings": [],
"numberOfTunnelsUsedByOtherFeatures": 0,
"networks": [],
"routes": [
{
"routeValue": "172.16.2.0/24",
"errors": [],
"warnings": []
}
],
"connections": [
{
"hubId": "9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866",
"tunnels": [
{
"spokeWanId": "WAN",
"hubWanId": "WAN",
"status": "connected"
}
]
}
],
"applyStatus": "OK"
}
],
"lastGeneratedAt": 1739454923342,
"generateStatus": "OK",
"errors": [],
"warnings": []
},
"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 status 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 status 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"
}