Update Edge Profile QOS

Update Edge Profile QOS

Perform a partial update to Edge-specific QOS module for a customer Edge

Request
URI
PATCH
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/qos
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

string
edgeLogicalId
Required

The logicalId GUID for the target edge

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.


Request Body

Update Edge-specific QOS module request schema

Array of PatchSchema of type(s) application/json
Optional
[
    {
        "op": "replace",
        "path": "/softwareUpdate/windowed",
        "value": true
    },
    {
        "op": "remove",
        "path": "/lan/networks/0"
    },
    {
        "op": "add",
        "path": "/snmp/snmpv2c/allowedIp",
        "value": "1.2.3.4"
    },
    {
        "op": "move",
        "from": "/lan/networks/0/interfaces/0",
        "path": "/lan/networks/1/interfaces/1"
    }
]
Responses
200

Request successfully processed

Returns BaseQOS of type(s) application/json
{
    "serviceRateLimit": {
        "enabled": false,
        "inputType": "string",
        "value": 0
    },
    "segments": [
        {
            "rules": [
                {
                    "name": "string",
                    "match": {
                        "appid": 0,
                        "classid": 0,
                        "application": {
                            "_href": "string",
                            "name": "string",
                            "displayName": "string",
                            "class": 0,
                            "description": "string",
                            "knownIpPortMapping": {},
                            "protocolPortMapping": {},
                            "mustNotPerformDpi": 0
                        },
                        "applicationClass": {
                            "_href": "string",
                            "id": "number",
                            "name": "string"
                        },
                        "dscp": 0,
                        "sip": "string",
                        "sport_high": 0,
                        "sport_low": 0,
                        "sAddressGroup": "string",
                        "sPortGroup": "string",
                        "ssm": "string",
                        "svlan": 0,
                        "sInterface": "string",
                        "os_version": 0,
                        "hostname": "string",
                        "dip": "string",
                        "dport_low": 0,
                        "dport_high": 0,
                        "dAddressGroup": "string",
                        "dPortGroup": "string",
                        "dsm": "string",
                        "dvlan": 0,
                        "dInterface": "string",
                        "proto": 0,
                        "s_rule_type": "string",
                        "d_rule_type": "string",
                        "ipVersion": "string",
                        "sipV6": "string",
                        "dipV6": "string"
                    },
                    "action": {
                        "routePolicy": "string",
                        "routeType": "string",
                        "allowConditionalBh": false,
                        "userDisableConditionalBh": false,
                        "edge2EdgeRouteAction": {
                            "interface": "string",
                            "linkInternalLogicalId": "string",
                            "link": {
                                "_href": "string"
                            },
                            "linkPolicy": "string",
                            "routeCfg": {},
                            "routePolicy": "string",
                            "serviceGroup": "string",
                            "vlanId": 0,
                            "wanlink": "string",
                            "wanLinkName": "string",
                            "subinterfaceId": 0,
                            "linkCosLogicalId": "string",
                            "linkOuterDscpTag": "string",
                            "linkInnerDscpTag": "string"
                        },
                        "edge2DataCenterRouteAction": {
                            "interface": "string",
                            "linkInternalLogicalId": "string",
                            "link": {
                                "_href": "string"
                            },
                            "linkPolicy": "string",
                            "routeCfg": {},
                            "routePolicy": "string",
                            "serviceGroup": "string",
                            "vlanId": 0,
                            "wanlink": "string",
                            "wanLinkName": "string",
                            "subinterfaceId": 0,
                            "linkCosLogicalId": "string",
                            "linkOuterDscpTag": "string",
                            "linkInnerDscpTag": "string"
                        },
                        "edge2CloudRouteAction": {
                            "interface": "string",
                            "linkInternalLogicalId": "string",
                            "link": {
                                "_href": "string"
                            },
                            "linkPolicy": "string",
                            "routeCfg": {},
                            "routePolicy": "string",
                            "serviceGroup": "string",
                            "vlanId": 0,
                            "wanlink": "string",
                            "wanLinkName": "string",
                            "subinterfaceId": 0,
                            "linkCosLogicalId": "string",
                            "linkOuterDscpTag": "string",
                            "linkInnerDscpTag": "string"
                        },
                        "QoS": {},
                        "sla": {},
                        "natIpVersion": "string",
                        "nat": {
                            "sourceIp": "string",
                            "destIp": "string"
                        },
                        "natV6": {
                            "sourceIp": "string",
                            "destIp": "string"
                        }
                    },
                    "ruleLogicalId": "string"
                }
            ],
            "defaults": [
                {}
            ],
            "webProxy": {
                "providers": [
                    {}
                ]
            },
            "segment": {
                "_href": "string",
                "created": "string",
                "description": "string",
                "object": "string",
                "name": "string",
                "type": "string",
                "alertsEnabled": 0,
                "operatorAlertsEnabled": 0,
                "status": "string",
                "statusModified": "string",
                "previousData": {},
                "previousCreated": "string",
                "draftData": "string",
                "draftCreated": "string",
                "draftComment": "string",
                "data": {},
                "lastContact": "string",
                "version": "string",
                "modified": "string"
            },
            "cosMapping": {
                "lsInputType": "string",
                "bulk": {
                    "high": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "normal": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "low": {
                        "value": 0,
                        "ratelimit": false
                    }
                },
                "realtime": {
                    "high": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "normal": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "low": {
                        "value": 0,
                        "ratelimit": false
                    }
                },
                "transactional": {
                    "high": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "normal": {
                        "value": 0,
                        "ratelimit": false
                    },
                    "low": {
                        "value": 0,
                        "ratelimit": false
                    }
                }
            }
        }
    ],
    "qoe": {
        "voice": {
            "latency": {
                "yellow": 0,
                "red": 0
            }
        },
        "video": {
            "latency": {
                "yellow": 0,
                "red": 0
            }
        },
        "transactional": {
            "latency": {
                "yellow": 0,
                "red": 0
            }
        }
    }
}
serviceRateLimit
Optional

serviceRateLimit

segments
Required

segments

qoe
Optional

qoe


400

ValidationError

Returns ValidationError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


415

UnsupportedMediaTypeError

Returns UnsupportedMediaTypeError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation