Get Enterprise Edges

Get Enterprise Edges

List Customer Edges

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

The logicalId GUID for the target enterprise

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.

string
prevPageLink
Optional

A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.

string
nextPageLink
Optional

A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.

integer,null
limit
Optional

Limits the maximum size of the result set.

string
sortBy
Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>

string
name[is]
Optional

Filter by name[is]

string
name[isNot]
Optional

Filter by name[isNot]

string
name[isNull]
Optional

Filter by name[isNull]

string
name[isNotNull]
Optional

Filter by name[isNotNull]

string
name[startsWith]
Optional

Filter by name[startsWith]

string
name[notStartsWith]
Optional

Filter by name[notStartsWith]

string
name[endsWith]
Optional

Filter by name[endsWith]

string
name[notEndsWith]
Optional

Filter by name[notEndsWith]

string
name[contains]
Optional

Filter by name[contains]

string
name[notContains]
Optional

Filter by name[notContains]

string
name[in]
Optional

Filter by name[in]

string
name[notIn]
Optional

Filter by name[notIn]

integer
created[is]
Optional

Filter by created[is]

integer
created[isNot]
Optional

Filter by created[isNot]

integer
created[isNull]
Optional

Filter by created[isNull]

integer
created[isNotNull]
Optional

Filter by created[isNotNull]

integer
created[greaterOrEquals]
Optional

Filter by created[greaterOrEquals]

integer
created[lesserOrEquals]
Optional

Filter by created[lesserOrEquals]

integer
created[in]
Optional

Filter by created[in]

integer
created[notIn]
Optional

Filter by created[notIn]

string
activationState[is]
Optional

Filter by activationState[is]

Possible values are : UNASSIGNED, PENDING, ACTIVATED, REACTIVATION_PENDING,
string
activationState[isNot]
Optional

Filter by activationState[isNot]

Possible values are : UNASSIGNED, PENDING, ACTIVATED, REACTIVATION_PENDING,
string
activationState[in]
Optional

Filter by activationState[in]

Possible values are : UNASSIGNED, PENDING, ACTIVATED, REACTIVATION_PENDING,
string
activationState[notIn]
Optional

Filter by activationState[notIn]

Possible values are : UNASSIGNED, PENDING, ACTIVATED, REACTIVATION_PENDING,
string
modelNumber[is]
Optional

Filter by modelNumber[is]

Possible values are : edge500, edge5X0, edge510, edge510lte, edge515, edge6X0, edge610lte, me6200, edge710, edge7105g, edge7X0, edge840, edge1000, edge1000qat, edge3X00, edge3X10, virtual,
string
modelNumber[isNot]
Optional

Filter by modelNumber[isNot]

Possible values are : edge500, edge5X0, edge510, edge510lte, edge515, edge6X0, edge610lte, me6200, edge710, edge7105g, edge7X0, edge840, edge1000, edge1000qat, edge3X00, edge3X10, virtual,
string
modelNumber[in]
Optional

Filter by modelNumber[in]

Possible values are : edge500, edge5X0, edge510, edge510lte, edge515, edge6X0, edge610lte, me6200, edge710, edge7105g, edge7X0, edge840, edge1000, edge1000qat, edge3X00, edge3X10, virtual,
string
modelNumber[notIn]
Optional

Filter by modelNumber[notIn]

Possible values are : edge500, edge5X0, edge510, edge510lte, edge515, edge6X0, edge610lte, me6200, edge710, edge7105g, edge7X0, edge840, edge1000, edge1000qat, edge3X00, edge3X10, virtual,
string
edgeState[is]
Optional

Filter by edgeState[is]

Possible values are : NEVER_ACTIVATED, DEGRADED, OFFLINE, DISABLED, EXPIRED, CONNECTED,
string
edgeState[isNot]
Optional

Filter by edgeState[isNot]

Possible values are : NEVER_ACTIVATED, DEGRADED, OFFLINE, DISABLED, EXPIRED, CONNECTED,
string
edgeState[in]
Optional

Filter by edgeState[in]

Possible values are : NEVER_ACTIVATED, DEGRADED, OFFLINE, DISABLED, EXPIRED, CONNECTED,
string
edgeState[notIn]
Optional

Filter by edgeState[notIn]

Possible values are : NEVER_ACTIVATED, DEGRADED, OFFLINE, DISABLED, EXPIRED, CONNECTED,
string
buildNumber[is]
Optional

Filter by buildNumber[is]

string
buildNumber[isNot]
Optional

Filter by buildNumber[isNot]

string
buildNumber[isNull]
Optional

Filter by buildNumber[isNull]

string
buildNumber[isNotNull]
Optional

Filter by buildNumber[isNotNull]

string
buildNumber[startsWith]
Optional

Filter by buildNumber[startsWith]

string
buildNumber[notStartsWith]
Optional

Filter by buildNumber[notStartsWith]

string
buildNumber[endsWith]
Optional

Filter by buildNumber[endsWith]

string
buildNumber[notEndsWith]
Optional

Filter by buildNumber[notEndsWith]

string
buildNumber[contains]
Optional

Filter by buildNumber[contains]

string
buildNumber[notContains]
Optional

Filter by buildNumber[notContains]

string
buildNumber[in]
Optional

Filter by buildNumber[in]

string
buildNumber[notIn]
Optional

Filter by buildNumber[notIn]

string
softwareVersion[is]
Optional

Filter by softwareVersion[is]

string
softwareVersion[isNot]
Optional

Filter by softwareVersion[isNot]

string
softwareVersion[isNull]
Optional

Filter by softwareVersion[isNull]

string
softwareVersion[isNotNull]
Optional

Filter by softwareVersion[isNotNull]

string
softwareVersion[startsWith]
Optional

Filter by softwareVersion[startsWith]

string
softwareVersion[notStartsWith]
Optional

Filter by softwareVersion[notStartsWith]

string
softwareVersion[endsWith]
Optional

Filter by softwareVersion[endsWith]

string
softwareVersion[notEndsWith]
Optional

Filter by softwareVersion[notEndsWith]

string
softwareVersion[contains]
Optional

Filter by softwareVersion[contains]

string
softwareVersion[notContains]
Optional

Filter by softwareVersion[notContains]

string
softwareVersion[in]
Optional

Filter by softwareVersion[in]

string
softwareVersion[notIn]
Optional

Filter by softwareVersion[notIn]

string
serialNumber[is]
Optional

Filter by serialNumber[is]

string
serialNumber[isNot]
Optional

Filter by serialNumber[isNot]

string
serialNumber[isNull]
Optional

Filter by serialNumber[isNull]

string
serialNumber[isNotNull]
Optional

Filter by serialNumber[isNotNull]

string
serialNumber[startsWith]
Optional

Filter by serialNumber[startsWith]

string
serialNumber[notStartsWith]
Optional

Filter by serialNumber[notStartsWith]

string
serialNumber[endsWith]
Optional

Filter by serialNumber[endsWith]

string
serialNumber[notEndsWith]
Optional

Filter by serialNumber[notEndsWith]

string
serialNumber[contains]
Optional

Filter by serialNumber[contains]

string
serialNumber[notContains]
Optional

Filter by serialNumber[notContains]

string
serialNumber[in]
Optional

Filter by serialNumber[in]

string
serialNumber[notIn]
Optional

Filter by serialNumber[notIn]

integer
softwareUpdated[is]
Optional

Filter by softwareUpdated[is]

integer
softwareUpdated[isNot]
Optional

Filter by softwareUpdated[isNot]

integer
softwareUpdated[isNull]
Optional

Filter by softwareUpdated[isNull]

integer
softwareUpdated[isNotNull]
Optional

Filter by softwareUpdated[isNotNull]

integer
softwareUpdated[greaterOrEquals]
Optional

Filter by softwareUpdated[greaterOrEquals]

integer
softwareUpdated[lesserOrEquals]
Optional

Filter by softwareUpdated[lesserOrEquals]

integer
softwareUpdated[in]
Optional

Filter by softwareUpdated[in]

integer
softwareUpdated[notIn]
Optional

Filter by softwareUpdated[notIn]

string
customInfo[is]
Optional

Filter by customInfo[is]

string
customInfo[isNot]
Optional

Filter by customInfo[isNot]

string
customInfo[isNull]
Optional

Filter by customInfo[isNull]

string
customInfo[isNotNull]
Optional

Filter by customInfo[isNotNull]

string
customInfo[startsWith]
Optional

Filter by customInfo[startsWith]

string
customInfo[notStartsWith]
Optional

Filter by customInfo[notStartsWith]

string
customInfo[endsWith]
Optional

Filter by customInfo[endsWith]

string
customInfo[notEndsWith]
Optional

Filter by customInfo[notEndsWith]

string
customInfo[contains]
Optional

Filter by customInfo[contains]

string
customInfo[notContains]
Optional

Filter by customInfo[notContains]

string
customInfo[in]
Optional

Filter by customInfo[in]

string
customInfo[notIn]
Optional

Filter by customInfo[notIn]

Responses
200

Request successfully processed

Returns EdgeResourceCollection of type(s) application/json 
{
    "_href": "string",
    "data": [
        {
            "_href": "string",
            "activationKey": "string",
            "activationKeyExpires": "string",
            "activationState": "string",
            "activationTime": "string",
            "alertsEnabled": false,
            "bastionState": "string",
            "buildNumber": "string",
            "created": "string",
            "customInfo": "string",
            "description": "string",
            "deviceFamily": "string",
            "deviceId": "string",
            "dnsName": "string",
            "edgeState": "string",
            "edgeStateTime": "string",
            "endpointPkiMode": "string",
            "factoryBuildNumber": "string",
            "factorySoftwareVersion": "string",
            "platformBuildNumber": "string",
            "platformFirmwareVersion": "string",
            "modemBuildNumber": "string",
            "modemFirmwareVersion": "string",
            "lteRegion": "string",
            "haLastContact": "string",
            "haPreviousState": "string",
            "haSerialNumber": "string",
            "haState": "string",
            "isLive": false,
            "lastContact": "string",
            "logicalId": "string",
            "modelNumber": "string",
            "modified": "string",
            "name": "string",
            "operatorAlertsEnabled": false,
            "selfMacAddress": "string",
            "serialNumber": "string",
            "serviceState": "string",
            "serviceUpSince": "string",
            "softwareUpdated": "string",
            "softwareVersion": "string",
            "systemUpSince": "string",
            "links": [
                {
                    "_href": "string"
                }
            ],
            "site": {
                "_href": "string",
                "created": "string",
                "name": "string",
                "contactName": "string",
                "contactPhone": "string",
                "contactMobile": "string",
                "contactEmail": "string",
                "streetAddress": "string",
                "streetAddress2": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "postalCode": "string",
                "lat": "number",
                "lon": "number",
                "timezone": "string",
                "locale": "string",
                "shippingSameAsLocation": false,
                "shippingContactName": "string",
                "shippingAddress": "string",
                "shippingAddress2": "string",
                "shippingCity": "string",
                "shippingState": "string",
                "shippingCountry": "string",
                "shippingPostalCode": "string",
                "modified": "string"
            },
            "enterprise": {
                "_href": "string",
                "created": "string",
                "alertsEnabled": false,
                "operatorAlertsEnabled": false,
                "endpointPkiMode": "string",
                "name": "string",
                "domain": "string",
                "prefix": "string",
                "logicalId": "string",
                "accountNumber": "string",
                "description": "string",
                "contactName": "string",
                "contactPhone": "string",
                "contactMobile": "string",
                "contactEmail": "string",
                "streetAddress": "string",
                "streetAddress2": "string",
                "city": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "lat": "number",
                "lon": "number",
                "timezone": "string",
                "locale": "string",
                "modified": "string",
                "gatewayPool": {
                    "_href": "string"
                },
                "bastionState": "string"
            },
            "haMode": "string",
            "standbySystemUpSince": "string",
            "standbyServiceUpSince": "string",
            "standbySoftwareVersion": "string",
            "standbyFactorySoftwareVersion": "string",
            "standbyFactoryBuildNumber": "string",
            "standbyBuildNumber": "string",
            "standbyModelNumber": "string",
            "standbyDeviceId": "string"
        }
    ],
    "metaData": {
        "prevPageLink": "string",
        "nextPageLink": "string",
        "limit": 0,
        "more": false
    }
}
string
_href
Optional

_href

array of EdgeResource
data
Optional

data

PaginationMetaData
metaData
Optional

metaData


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

array of ValidationErrorListItem
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


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


On This Page
Monitor Operations
GET
Get Edge Application
GET
Get Edge Applications
GET
Get Edge Firewall Idps Stats Series
GET
Get Edge Flow Metrics
GET
Get Edge Flow Series
GET
Get Edge Health Metrics
GET
Get Edge Health Series
GET
Get Edge Link Metrics
GET
Get Edge Link Quality Events
GET
Get Edge Link Quality Series
GET
Get Edge Link Series
GET
Get Edge Path Metrics
GET
Get Edge Path Series
GET
Get Enterprise Edge
GET
Get Enterprise Edges