Get Eligible Enterprises For Migration

Get Eligible Enterprises For Migration

Get the eligible Enterprises that can be migrated off given Gateway as the Blue Gateway and optionally given green Gateway (in query parameter)

Request
URI
GET
https://{api_host}/api/sdwan/v2/gateways/{gatewayLogicalId}/eligibleEnterprisesForMigration
COPY
Path Parameters
string
gatewayLogicalId
Required

The logicalId GUID of the Gateway

Query Parameters
string
greenGateway
Optional

The logicalId GUID for the intended green Gateway for the gateway migration


Responses
200

Request successfully processed

Returns Array of EligibleEnterpriseResource of type(s) application/json
[
    {
        "_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",
        "blueGatewayConnectivityStats": {
            "connectedVceCount": "number",
            "tunnelCount": "number",
            "tunnelCountV6": "number",
            "establishedNsdTunnelCount": "number",
            "flowCount": "number"
        },
        "greenGatewayConnectivityStats": {
            "connectedVceCount": "number",
            "tunnelCount": "number",
            "tunnelCountV6": "number",
            "establishedNsdTunnelCount": "number",
            "flowCount": "number"
        }
    }
]

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