Skip to content

Commit 80e00d8

Browse files
committed
Updated descriptions and examples.
1 parent bfe95b3 commit 80e00d8

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

openapi.yaml

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6200,7 +6200,7 @@ paths:
62006200
--authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \
62016201
--authorized_users "myUser" \
62026202
--authorized_users "secondaryUser" \
6203-
--metadata.user_data "I2Nsb3VkLWNvbmZpZw==)"
6203+
--metadata.user_data "I2Nsb3VkLWNvbmZpZw=="
62046204
/linode/instances/{linodeId}:
62056205
parameters:
62066206
- name: linodeId
@@ -6796,6 +6796,8 @@ paths:
67966796
returned by this endpoint.
67976797

67986798
Any [tags](/docs/api/tags/#tags-list) existing on the source Linode will be cloned to the target Linode.
6799+
6800+
Linodes utilizing Metadata (`"has_user_data": true`) must be cloned to a new Linode with `metadata.user_data` included with the clone request.
67996801
tags:
68006802
- Linode Instances
68016803
operationId: cloneLinodeInstance
@@ -6923,6 +6925,8 @@ paths:
69236925

69246926
* Can only be provided when cloning to a new Linode.
69256927
example: true
6928+
metadata:
6929+
$ref: '#/components/schemas/LinodeRequest/properties/metadata'
69266930
responses:
69276931
'200':
69286932
description: Clone started.
@@ -6946,7 +6950,10 @@ paths:
69466950
"backups_enabled": true,
69476951
"disks": [25674],
69486952
"configs": [23456],
6949-
"private_ip": true
6953+
"private_ip": true,
6954+
"metadata": {
6955+
"user_data": "I2Nsb3VkLWNvbmZpZw=="
6956+
}
69506957
}' \
69516958
https://api.linode.com/v4/linode/instances/123/clone
69526959
- lang: CLI
@@ -6959,7 +6966,8 @@ paths:
69596966
--backups_enabled true \
69606967
--disks 25674 \
69616968
--configs 23456 \
6962-
--private_ip true
6969+
--private_ip true \
6970+
--metadata.user_data I2Nsb3VkLWNvbmZpZw==
69636971
/linode/instances/{linodeId}/configs:
69646972
parameters:
69656973
- name: linodeId
@@ -8480,6 +8488,7 @@ paths:
84808488
* Requires a `root_pass` be supplied to use for the root User's Account.
84818489
* It is recommended to supply SSH keys for the root User using the
84828490
`authorized_keys` field.
8491+
* Linodes utilizing Metadata (`"has_user_data": true`) should include `metadata.user_data` in the rebuild request to continue using the service.
84838492

84848493
You also have the option to resize the Linode to a different plan by including the `type` parameter with your request. Note that resizing involves migrating the Linode to a new hardware host, while rebuilding without resizing maintains the same hardware host. Resizing also requires significantly more time for completion of this command. The following additional conditions apply:
84858494

@@ -8543,7 +8552,10 @@ paths:
85438552
"stackscript_data": {
85448553
"gh_username": "linode"
85458554
}
8546-
"type": "g6-standard-2"
8555+
"type": "g6-standard-2",
8556+
"metadata": {
8557+
"user_data": "I2Nsb3VkLWNvbmZpZw=="
8558+
}
85478559
}' \
85488560
https://api.linode.com/v4/linode/instances/123/rebuild
85498561
- lang: CLI
@@ -8557,7 +8569,8 @@ paths:
85578569
--booted true \
85588570
--stackscript_id 10079 \
85598571
--stackscript_data '{"gh_username": "linode"}' \
8560-
--type "g6-standard-2"
8572+
--type "g6-standard-2" \
8573+
--metadata.userdata "I2Nsb3VkLWNvbmZpZw=="
85618574
/linode/instances/{linodeId}/rescue:
85628575
parameters:
85638576
- name: linodeId
@@ -22728,6 +22741,8 @@ components:
2272822741
description: |
2272922742
Base64-encoded [cloud-config](/docs/products/compute/compute-instances/guides/metadata-cloud-config/) data.
2273022743

22744+
Cannot be modified after provisioning. To update, use either the [Linode Clone](/docs/api/linode-instances/#linode-clone) or [Linode Rebuild](/docs/api/linode-instances/#linode-rebuild) commands.
22745+
2273122746
Must not be included when cloning to an existing Linode.
2273222747

2273322748
Unencoded data must not exceed 65535 bytes, or about 16kb encoded.

0 commit comments

Comments
 (0)