Get Enterprise Edge

Get Enterprise Edge

Get an Edge

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/
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.

Responses
200

Request successfully processed

Returns EdgeResource of type(s) application/json 
{
    "_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"
}
string
_href
Optional

_href

string
activationKey
Optional

activationKey

string As date-time As date-time
activationKeyExpires
Optional

activationKeyExpires

string
activationState
Optional

activationState

Possible values are : UNASSIGNED, PENDING, ACTIVATED, REACTIVATION_PENDING,
string As date-time As date-time
activationTime
Optional

activationTime

boolean
alertsEnabled
Optional

alertsEnabled

string
bastionState
Optional

bastionState

Possible values are : UNCONFIGURED, STAGE_REQUESTED, UNSTAGE_REQUESTED, STAGED, UNSTAGED, PROMOTION_REQUESTED, PROMOTION_PENDING, PROMOTED,
string
buildNumber
Optional

buildNumber

string As date-time As date-time
created
Optional

created

string
customInfo
Optional

customInfo

string
description
Optional

description

string
deviceFamily
Optional

deviceFamily

string
deviceId
Optional

deviceId

string
dnsName
Optional

dnsName

string
edgeState
Optional

edgeState

Possible values are : NEVER_ACTIVATED, DEGRADED, OFFLINE, DISABLED, EXPIRED, CONNECTED,
string As date-time As date-time
edgeStateTime
Optional

edgeStateTime

string
endpointPkiMode
Optional

endpointPkiMode

Possible values are : CERTIFICATE_DISABLED, CERTIFICATE_OPTIONAL, CERTIFICATE_REQUIRED,
string
factoryBuildNumber
Optional

factoryBuildNumber

string
factorySoftwareVersion
Optional

factorySoftwareVersion

string
platformBuildNumber
Optional

platformBuildNumber

string
platformFirmwareVersion
Optional

platformFirmwareVersion

string
modemBuildNumber
Optional

modemBuildNumber

string
modemFirmwareVersion
Optional

modemFirmwareVersion

string
lteRegion
Optional

lteRegion

string As date-time As date-time
haLastContact
Optional

haLastContact

string
haPreviousState
Optional

haPreviousState

Possible values are : UNCONFIGURED, PENDING_INIT, PENDING_CONFIRMATION, PENDING_CONFIRMED, PENDING_DISSOCIATION, READY, FAILED,
string
haSerialNumber
Optional

haSerialNumber

string
haState
Optional

haState

Possible values are : UNCONFIGURED, PENDING_INIT, PENDING_CONFIRMATION, PENDING_CONFIRMED, PENDING_DISSOCIATION, READY, FAILED,
boolean
isLive
Optional

isLive

string As date-time As date-time
lastContact
Optional

This field is deprecated. Please use "edgeState" to get updated edge status calculated by the Orchestrator.

string
logicalId
Optional

logicalId

string
modelNumber
Optional

modelNumber

string As date-time As date-time
modified
Optional

modified

string
name
Optional

name

boolean
operatorAlertsEnabled
Optional

operatorAlertsEnabled

string
selfMacAddress
Optional

selfMacAddress

string
serialNumber
Optional

serialNumber

string
serviceState
Optional

serviceState

Possible values are : IN_SERVICE, OUT_OF_SERVICE, PENDING_SERVICE,
string As date-time As date-time
serviceUpSince
Optional

serviceUpSince

string As date-time As date-time
softwareUpdated
Optional

softwareUpdated

string
softwareVersion
Optional

softwareVersion

string As date-time As date-time
systemUpSince
Optional

systemUpSince

array of BaseApiResource
links
Optional

links

SiteResource
site
Optional

site

EnterpriseResource
enterprise
Optional

enterprise

string
haMode
Optional

haMode

string As date-time As date-time
standbySystemUpSince
Optional

standbySystemUpSince

string As date-time As date-time
standbyServiceUpSince
Optional

standbyServiceUpSince

string
standbySoftwareVersion
Optional

standbySoftwareVersion

string
standbyFactorySoftwareVersion
Optional

standbyFactorySoftwareVersion

string
standbyFactoryBuildNumber
Optional

standbyFactoryBuildNumber

string
standbyBuildNumber
Optional

standbyBuildNumber

string
standbyModelNumber
Optional

standbyModelNumber

string
standbyDeviceId
Optional

standbyDeviceId


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