Skip to content

Commit e318d6d

Browse files
[Update] POST /linode/instances/{linodeId}/migrate (#119)
* Add more details about /linode/instances/{linodeId}/migrate * Add region parameter to CLI example * Add changes requested by reviewer
1 parent 55c4630 commit e318d6d

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

openapi.yaml

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4937,13 +4937,26 @@ paths:
49374937
x-linode-cli-command: linodes
49384938
post:
49394939
x-linode-grant: read_write
4940-
summary: Initiate Pending Migration
4940+
summary: Initiate Pending Host Migration/DC Migration
49414941
description: >
4942-
In some circumstances, a Linode may have pending migrations scheduled that
4943-
you can initiate when convenient. In these cases, a Notification
4944-
will be returned from [GET /account/notifications](#getNotifications).
4945-
This endpoint initiates the scheduled migration, which will shut the Linode
4946-
down, migrate it, and then bring it back to its original state.
4942+
Initiate a pending host migration that has been scheduled by Linode or
4943+
initiate a cross data center (DC) migration. A list of pending migrations,
4944+
if any, can be accessed from [GET /account/notifications](/api/v4/account-notifications).
4945+
When the migration begins, your Linode will be shutdown if not already off.
4946+
If the migration initiated the shutdown, it will reboot the Linode when completed.
4947+
4948+
4949+
To initiate a cross DC migration, you must pass a `region` parameter to the
4950+
request body specifying the target data center region.
4951+
You can view a list of all available regions and their feature capabilities
4952+
from [GET /regions](/api/v4/regions). If your Linode has a DC migration already queued
4953+
or you have initiated a previously scheduled migration, you will not be able to initiate
4954+
a DC migration until it has completed.
4955+
4956+
4957+
**Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover.
4958+
If you have these features enabled on your Linode and attempt to migrate to an NGN data center,
4959+
the migration will not initiate. NGN data centers include Toronto and Mumbai.
49474960
tags:
49484961
- Linode Instances
49494962
operationId: migrateLinodeInstance
@@ -4963,8 +4976,10 @@ paths:
49634976
The region to which the Linode will be migrated.
49644977
Must be a valid region slug. A list of regions can be viewed
49654978
by using the [GET /regions](/api/v4/regions) endpoint.
4966-
A cross-region migration will cancel a pending migration
4979+
A cross data center migration will cancel a pending migration
49674980
that has not yet been initiated.
4981+
4982+
A cross data center migration will initiate a `linode_migrate_datacenter_create` event.
49684983
example: us-east
49694984
responses:
49704985
'200':
@@ -4975,6 +4990,18 @@ paths:
49754990
type: object
49764991
default:
49774992
$ref: '#/components/responses/ErrorResponse'
4993+
x-code-samples:
4994+
- lang: Shell
4995+
source: >
4996+
curl -H "Content-Type: application/json" \
4997+
-H "Authorization: Bearer $TOKEN" \
4998+
-X POST -d '{
4999+
"region": "us-central"
5000+
}' \
5001+
https://api.linode.com/v4/linode/instances/123/migrate
5002+
- lang: CLI
5003+
source: >
5004+
linode-cli linodes migrate 123 --region us-central
49785005
/linode/instances/{linodeId}/mutate:
49795006
parameters:
49805007
- name: linodeId

0 commit comments

Comments
 (0)