Update Gateway Migration

• Configure
• 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 UpdateMigrationJobSpec of type(s) application/json

Optional

[
    {
        "op": "replace",
        "path": "/migrationStatus",
        "value": "GATEWAY_MIGRATION_FINALIZED"
    }
]

Responses

200

Hide Details

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

auditLog

400

Hide Details

ValidationError

Returns ValidationError of type(s) application/json

{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "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

array of ValidationErrorListItem

errors

Optional

A list of property-specific errors

401

Hide Details

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

Hide Details

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

415

Hide Details

UnsupportedMediaTypeError

Returns UnsupportedMediaTypeError 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

422

Hide Details

DataValidationError

Returns DataValidationError 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

Hide Details

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

Hide Details

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

Description

Request

Path Parameters

Request Body

Response

200 Response Body

Errors

Configure Operations

DELETE

Delete Gateway Migration

GET

Get Eligible Enterprises For Migration

GET

Get Eligible Green Gateways For Migration

POST

Start Gateway Migrations

PATCH

Update Gateway Migration