Get Gateway Migrations

Get Gateway Migrations

Fetch the Hitless Gateway migration jobs with this gateway as the Blue gateway

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

The logicalId GUID of the Gateway

Responses
200

Request successfully processed

Returns Array of object of type(s) application/json 
[
    {
        "logicalId": "string",
        "name": "string",
        "description": "string",
        "enterprise": {
            "logicalId": "string",
            "name": "string"
        },
        "greenGateway": {
            "logicalId": "string",
            "name": "string"
        },
        "migrationStatus": "string",
        "created": "string",
        "modified": "string",
        "auditLog": [
            {
                "statusChange": "string",
                "user": "string",
                "time": "string",
                "message": "string"
            }
        ]
    }
]

401

Unauthorized

Returns UnAuthorized of type(s) application/json 
"UnAuthorized Object"
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 
"ResourceNotFoundError Object"
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 
"RateLimitExceededError Object"
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 
"InternalServerError Object"
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


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/api/sdwan/v2/gateways/{gatewayLogicalId}/migrations
On This Page
Monitor Operations
GET
Get Gateway Migrations
POST
Start Gateway Migrations
GET
Get Gateway Migration
PATCH
Update Gateway Migration
DELETE
Delete Gateway Migration
GET
Get Migration Job Stats