Update Gateway Migration

Update Gateway Migration

Finalize, Abort Migration or Complete Migration associated with given migration job logicalId on this gateway acting as the Blue Gateway

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

The logicalId GUID of the Gateway

string
migrationLogicalId
Required

The logicalId GUID of the migration job on a Gateway

Request Body

Update Gateway Migration Job request schema

Array of object of type(s) application/json
Optional 
"PatchGatewayMigrationJobRequestSchema Object"
Responses
200

Request successfully processed

Returns GatewayMigrationJob 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"
        }
    ]
}
string
logicalId
Required

logicalId

string
name
Required

name

string
description
Optional

description

object
enterprise
Required

enterprise

object
greenGateway
Required

greenGateway

string
migrationStatus
Required

migrationStatus

Possible values are : GATEWAY_MIGRATION_STAGE_1, GATEWAY_MIGRATION_FINALIZED, GATEWAY_MIGRATION_ABORTED, GATEWAY_MIGRATION_FAILED, GATEWAY_MIGRATION_COMPLETED,
string As date-time As date-time
created
Required

created

string As date-time As date-time
modified
Required

modified

array of object
auditLog
Required
Constraints: minItems: 1

auditLog


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 PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'
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