20
20
21
21
# Changelog
22
22
23
- [View our Changelog](/ changelog) to see release notes on all changes made to
24
- our API.
23
+ [View our Changelog](https://developers.linode.com/ changelog) to see release
24
+ notes on all changes made to our API.
25
25
26
26
# Access
27
27
@@ -42,15 +42,16 @@ info:
42
42
## OAuth
43
43
44
44
The OAuth workflow is a three-step process to authenticate a User before an
45
- application can start making API calls on the User's behalf.
45
+ application can start making API calls on the User's behalf. If all you need
46
+ is a Personal Access Token, feel free to skip ahead to the next section.
46
47
47
48
First, the User visits the application's website and is directed to log with
48
49
Linode. The User is then redirected to Linode's authentication server and
49
50
presented the scope levels the application is requesting. Once the User
50
51
accepts the request for access, we redirect them back to the application's
51
52
specified redirect URI with an access code.
52
53
53
- Once the User has logged in to Linode and you have received an access code,
54
+ Once the User has logged in to Linode and you have received an exchange code,
54
55
you will need to exchange that access code for an Authorization token. You
55
56
do this by making an HTTP POST request to the following address:
56
57
@@ -265,6 +266,16 @@ info:
265
266
]
266
267
}'
267
268
```
269
+
270
+ # CLI (Command Line Interface)
271
+
272
+ An _early access_ version of the [Linode CLI](https://bits.linode.com/LinodeAPI/linode-cli)
273
+ is now available to use. It requires a [Personal Access Token](/#section/Personal-Access-Token)
274
+ for authentication, and gives you access to all of the features and functionality
275
+ of the Linode API that are documented here with CLI examples.
276
+
277
+ Endpoints that do not have CLI examples are currently unavailable through the CLI, but
278
+ can be access via other methods such as Shell commands and other third-party applications.
268
279
contact :
269
280
name : Linode
270
281
url : /
@@ -368,7 +379,7 @@ paths:
368
379
This endpoint allows you to add/edit credit card information to your Account.
369
380
370
381
Only one credit card can be associated with your Account, so using this
371
- endpoint will overwrite any existing card information with the
382
+ endpoint will overwrite your currently active card information with the
372
383
new credit card.
373
384
operationId : createCreditCard
374
385
x-linode-cli-action : update-card
@@ -1519,11 +1530,6 @@ paths:
1519
1530
description : >
1520
1531
The new User's email address.
1521
1532
1522
- password :
1523
- type : string
1524
- description : >
1525
- The password this User will use to log in.
1526
- example : hunter7
1527
1533
responses :
1528
1534
' 200 ' :
1529
1535
description : New User created successfully.
@@ -1700,7 +1706,7 @@ paths:
1700
1706
' 204 ' :
1701
1707
description : >
1702
1708
This is an unrestricted User, and therefore has no grants to return.
1703
- this User may access everything on the account and perform all actions.
1709
+ This User may access everything on the account and perform all actions.
1704
1710
default :
1705
1711
$ref : ' #/components/responses/ErrorResponse'
1706
1712
x-code-samples :
@@ -2564,30 +2570,30 @@ paths:
2564
2570
2565
2571
Linodes can be created in a number of ways:
2566
2572
2567
- - Using a Linode Linux Distribution image or an image you created based on another Linode
2568
- - The Linode will be `running` after it completes `provisioning`
2569
- - A default config with two disks, one being a 512 swap disk, is created
2570
- - `swap_size` can be used to customize the swap disk size
2571
- - Requires a `password ` be supplied to use for the root User's account
2572
- - It is recommended to supply ssh keys for the root User using the `authorized_keys` field
2573
+ * Using a Linode Linux Distribution image or an image you created based on another Linode
2574
+ * The Linode will be `running` after it completes `provisioning`
2575
+ * A default config with two disks, one being a 512 swap disk, is created
2576
+ * `swap_size` can be used to customize the swap disk size
2577
+ * Requires a `root_pass ` be supplied to use for the root User's account
2578
+ * It is recommended to supply ssh keys for the root User using the `authorized_keys` field
2573
2579
2574
- - Using one of your own StackScripts or a public StackScript
2575
- - The Linode will be `running` after it completes `provisioning`
2576
- - Requires a compatible Linode Linux Distribution `image` to be supplied
2577
- - see [GET /linode/stackscript/{stackscriptId}](/#operation/getStackScript) for compatible images
2578
- - Requires a `root_pass` be supplied to use for the root User's account
2579
- - It is recommended to supply ssh keys for the root User using the `authorized_keys` field
2580
+ * Using one of your own StackScripts or a public StackScript
2581
+ * The Linode will be `running` after it completes `provisioning`
2582
+ * Requires a compatible Linode Linux Distribution `image` to be supplied
2583
+ * See [GET /linode/stackscript/{stackscriptId}](/#operation/getStackScript) for compatible images
2584
+ * Requires a `root_pass` be supplied to use for the root User's account
2585
+ * It is recommended to supply ssh keys for the root User using the `authorized_keys` field
2580
2586
2581
- - Using one of your other Linode's backups
2582
- - The Linode will be `running` after it completes `provisioning`
2583
- - The disks and config will match that of the Linode that was backed up
2584
- - The `root_pass` will match that of the Linode that was backed up
2587
+ * Using one of your other Linode's backups
2588
+ * The Linode will be `running` after it completes `provisioning`
2589
+ * The disks and config will match that of the Linode that was backed up
2590
+ * The `root_pass` will match that of the Linode that was backed up
2585
2591
2586
- - Create an empty Linode
2587
- - The Linode will remain `offline` and must be manually started
2588
- - see [POST /linode/instances/{linodeId}/boot](/#operation/bootLinodeInstance)
2589
- - Disks and Configs must be created manually
2590
- - This is only recommended for advanced use-cases
2592
+ * Create an empty Linode
2593
+ * The Linode will remain `offline` and must be manually started
2594
+ * See [POST /linode/instances/{linodeId}/boot](/#operation/bootLinodeInstance)
2595
+ * Disks and Configs must be created manually
2596
+ * This is only recommended for advanced use-cases
2591
2597
tags :
2592
2598
- Linode Instances
2593
2599
operationId : createLinodeInstance
@@ -4954,10 +4960,10 @@ paths:
4954
4960
x-code-samples :
4955
4961
- lang : Shell
4956
4962
source : >
4957
- curl https://api.linode.com/v4/linode/stackscripts/1337
4963
+ curl https://api.linode.com/v4/linode/stackscripts/10079
4958
4964
- lang : CLI
4959
4965
source : >
4960
- linode-cli stackscripts view 1337
4966
+ linode-cli stackscripts view 10079
4961
4967
put :
4962
4968
x-linode-grant : read_write
4963
4969
tags :
@@ -5003,10 +5009,10 @@ paths:
5003
5009
"rev_note": "Set up MySQL",
5004
5010
"script": "#!/bin/bash"
5005
5011
}' \
5006
- https://api.linode.com/v4/linode/stackscripts/1337
5012
+ https://api.linode.com/v4/linode/stackscripts/10079
5007
5013
- lang : CLI
5008
5014
source : >
5009
- linode-cli stackscripts update 1337 --label a-stackscript --description "This StackScript install and configures MySQL" --images "linode/debian9" --images "linode/debian8" --is_public true --rev_note "Set up MySQL" --script '#!/bin/bash'
5015
+ linode-cli stackscripts update 10079 --label a-stackscript --description "This StackScript install and configures MySQL" --images "linode/debian9" --images "linode/debian8" --is_public true --rev_note "Set up MySQL" --script '#!/bin/bash'
5010
5016
delete :
5011
5017
x-linode-grant : read_write
5012
5018
tags :
@@ -5035,10 +5041,10 @@ paths:
5035
5041
source : >
5036
5042
curl -H "Authorization: Bearer $TOKEN" \
5037
5043
-X DELETE \
5038
- https://api.linode.com/v4/linode/stackscripts/1337
5044
+ https://api.linode.com/v4/linode/stackscripts/10079
5039
5045
- lang : CLI
5040
5046
source : >
5041
- linode-cli stackscripts delete 1337
5047
+ linode-cli stackscripts delete 10079
5042
5048
/linode/types :
5043
5049
x-linode-cli-command : linodes
5044
5050
get :
@@ -5108,8 +5114,7 @@ paths:
5108
5114
x-code-samples :
5109
5115
- lang : Shell
5110
5116
source : >
5111
- curl -H "Authorization: Bearer $TOKEN" \
5112
- https://api.linode.com/v4/linode/types/g5-standard-2
5117
+ curl https://api.linode.com/v4/linode/types/g5-standard-2
5113
5118
- lang : CLI
5114
5119
source : >
5115
5120
linode-cli linodes type-view g5-standard-2
@@ -8587,7 +8592,11 @@ paths:
8587
8592
example : null
8588
8593
config_id :
8589
8594
type : integer
8590
- description : The ID of the Config used for the Volume.
8595
+ description : >
8596
+ When creating a volume attached to a Linode, the ID of the
8597
+ Linode Config to include the new Volume in. This Config
8598
+ must belong to the Linode referenced by linode_id. Must
8599
+ not be provided if linode_id is not sent.
8591
8600
example : 23456
8592
8601
responses :
8593
8602
' 200 ' :
@@ -8607,14 +8616,12 @@ paths:
8607
8616
-X POST -d '{
8608
8617
"label": "my-volume",
8609
8618
"size": 20,
8610
- "region": "us-east",
8611
- "linode_id": 12346,
8612
- "config_id": 23456
8619
+ "linode_id": 12346
8613
8620
}' \
8614
8621
https://api.linode.com/v4/volumes
8615
8622
- lang : CLI
8616
8623
source : >
8617
- linode-cli volumes create --label my-volume --size 20 --region us-east -- linode_id 12346 --config_id 23456
8624
+ linode-cli volumes create --label my-volume --size 20 --linode_id 12346 --no-defaults
8618
8625
/volumes/{volumeId} :
8619
8626
parameters :
8620
8627
- name : volumeId
@@ -8801,7 +8808,10 @@ paths:
8801
8808
readOnly : false
8802
8809
config_id :
8803
8810
type : integer
8804
- description : The ID of the Config used for the Volume.
8811
+ description : >
8812
+ The ID of the Linode Config to include this volume in. Must
8813
+ belong to the Linode referenced by `linode_id`. If not given,
8814
+ the last booted Config will be chosen.
8805
8815
example : 23456
8806
8816
responses :
8807
8817
' 200 ' :
@@ -9620,7 +9630,7 @@ components:
9620
9630
You may only deploy from a StackScript that you own or that is listed as
9621
9631
`public`.
9622
9632
9623
- This field cannot be used when deploying from a backup or a User made image.
9633
+ This field cannot be used when deploying from a backup or a private image.
9624
9634
stackscript_data :
9625
9635
type : object
9626
9636
title : Optional User-defined field data for this StackScript.
@@ -11807,7 +11817,7 @@ components:
11807
11817
minLength : 0
11808
11818
maxLength : 32
11809
11819
description : >
11810
- The User Linode's special forces should use when accessing this
11820
+ The user Linode's special forces should use when accessing this
11811
11821
Linode to respond to an issue.
11812
11822
example : linode
11813
11823
ip :
@@ -12829,7 +12839,7 @@ components:
12829
12839
id :
12830
12840
type : integer
12831
12841
description : The unique ID of this StackScript.
12832
- example : 1337
12842
+ example : 10079
12833
12843
readOnly : true
12834
12844
x-linode-cli-display : 1
12835
12845
username :
@@ -13225,7 +13235,7 @@ components:
13225
13235
minLength : 3
13226
13236
maxLength : 32
13227
13237
description : >
13228
- this User's username. This is used for logging in, and may also be
13238
+ This User's username. This is used for logging in, and may also be
13229
13239
displayed alongside actions the User performs (for example, in Events
13230
13240
or public StackScripts).
13231
13241
x-linode-filterable : true
0 commit comments