Start Gateway Migrations

Start Gateway Migrations

Start Hitless Enterprise migration jobs off this gateway acting as the Blue Gateway

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

The logicalId GUID of the Gateway


Request Body

Start Hitless Gateway migrations request schema

StartMigrationJobSpec of type(s) application/json
Optional
"StartMigrationJobSpec Object"
string
greenGateway
Required

Green Gateway Logical Id

array of string
enterprises
Required
Constraints: minItems: 1

enterprises

string
namePrefix
Optional

namePrefix

string
description
Optional

description

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"
            }
        ]
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json
"ValidationError 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

array of object
errors
Optional

A list of property-specific errors


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


415

UnsupportedMediaTypeError

Returns UnsupportedMediaTypeError of type(s) application/json
"UnsupportedMediaTypeError 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


422

DataValidationError

Returns DataValidationError of type(s) application/json
"DataValidationError 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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/sdwan/v2/gateways/{gatewayLogicalId}/migrations