You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi.yaml
+24-37Lines changed: 24 additions & 37 deletions
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ info:
22
22
23
23
## Changelog
24
24
25
-
<a target="_top" href="https://developers.linode.com/changelog">View our Changelog</a> to see release
25
+
<a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release
26
26
notes on all changes made to our API.
27
27
28
28
## Access and Authentication
@@ -54,7 +54,7 @@ info:
54
54
If you're designing an application that can authenticate with an arbitrary Linode user, then
55
55
you should use the OAuth 2.0 workflows presented in this section.
56
56
57
-
For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange).
57
+
For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange).
58
58
59
59
Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients):
60
60
@@ -1759,8 +1759,7 @@ paths:
1759
1759
description: |
1760
1760
The type of Payment Method.
1761
1761
1762
-
Alternative Payment Methods including Google Pay and PayPal can be added using Linode Cloud Manager. See our
1763
-
guide on [Managing Billing in the Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/)
1762
+
Alternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/) guide
1764
1763
for details and instructions.
1765
1764
example: 'credit_card'
1766
1765
is_default:
@@ -2072,9 +2071,7 @@ paths:
2072
2071
- Account
2073
2072
summary: PayPal Payment Stage
2074
2073
description: |
2075
-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2076
-
designated as a Payment Method for automated payments using
**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).
2078
2075
operationId: createPayPalPayment
2079
2076
x-linode-cli-action: paypal-start
2080
2077
security:
@@ -2140,9 +2137,7 @@ paths:
2140
2137
- Account
2141
2138
summary: Staged/Approved PayPal Payment Execute
2142
2139
description: |
2143
-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2144
-
designated as a Payment Method for automated payments using
**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).
2146
2141
operationId: executePayPalPayment
2147
2142
x-linode-cli-action: paypal-execute
2148
2143
security:
@@ -2641,7 +2636,7 @@ paths:
2641
2636
description: >
2642
2637
Enables Linode Managed for the entire account and sends a welcome email to the account's associated
2643
2638
email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587
6790
6785
on all Linodes for new accounts created after November 5th, 2019. For more information,
6791
-
see [Sending Email on Linode](/docs/email/running-a-mail-server/#sending-email-on-linode).
6786
+
see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).
6792
6787
6793
6788
Linodes can be created in a number of ways:
6794
6789
@@ -6821,7 +6816,7 @@ paths:
6821
6816
6822
6817
* Attached to a private VLAN.
6823
6818
* Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.
6824
-
* For more information, see our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/).
6819
+
* For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).
6825
6820
6826
6821
* Create an empty Linode.
6827
6822
* The Linode will remain `offline` and must be manually started.
@@ -9756,7 +9751,7 @@ paths:
9756
9751
If the request is not authenticated, only public StackScripts are returned.
9757
9752
9758
9753
9759
-
For more information on StackScripts, please read our [StackScripts guides](/docs/platform/stackscripts/).
9754
+
For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
9760
9755
operationId: getStackScripts
9761
9756
x-linode-cli-action:
9762
9757
- list
@@ -12132,7 +12127,7 @@ paths:
12132
12127
summary: Managed SSH Key View
12133
12128
description: |
12134
12129
Returns the unique SSH public key assigned to your Linode account's
12135
-
Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account,
12130
+
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
12136
12131
Linode special forces will be able to log in to the Linode with this key
12137
12132
when attempting to resolve issues.
12138
12133
@@ -14271,7 +14266,7 @@ paths:
14271
14266
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
14272
14267
you will be prompted to select a different data center or contact support.
14273
14268
14274
-
**Note:** See our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/) to view additional [limitations](/docs/guides/getting-started-with-vlans/#limitations).
14269
+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.
14275
14270
operationId: getVLANs
14276
14271
x-linode-cli-action:
14277
14272
- list
@@ -16590,7 +16585,7 @@ paths:
16590
16585
description: |
16591
16586
The amount of outbound data transfer used by your account's Object Storage buckets.
16592
16587
Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool.
16593
-
See the [Object Storage Pricing and Limitations](/docs/guides/pricing-and-limitations/)
16588
+
See the [Object Storage Overview](/docs/products/storage/object-storage/#pricing)
16594
16589
guide for details on Object Storage transfer quotas.
16595
16590
16596
16591
tags:
@@ -20776,7 +20771,7 @@ components:
20776
20771
description: |
20777
20772
This field is required only if the StackScript being deployed requires input
20778
20773
data from the User for successful completion. See
20779
-
[User Defined Fields (UDFs)](/docs/guides/writing-scripts-for-use-with-linode-stackscripts-a-tutorial/#user-defined-fields-udfs)
20774
+
[User Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs)
20780
20775
for more details. This field is required to be valid JSON.
20781
20776
Domain:
20782
20777
type: object
@@ -20962,9 +20957,7 @@ components:
20962
20957
- CAA
20963
20958
description: >
20964
20959
The type of Record this is in the DNS system. For example, A
20965
-
records associate a domain name with an IPv4 address, and AAAA
20966
-
records associate a domain name with an IPv6 address. For more information, see our guide on
records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on [DNS Record Types](/docs/products/networking/dns-manager/guides/#dns-record-types).
20968
20961
example: A
20969
20962
x-linode-filterable: true
20970
20963
x-linode-cli-display: 2
@@ -20990,7 +20983,7 @@ components:
20990
20983
`CAA`: The subdomain. Omit or enter an empty string (`""`) to apply to the entire Domain.
20991
20984
20992
20985
`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS
* `iodef`: Must be either (1) a valid domain, (2) a valid domain prepended with `http://` or `https://`, or (3) a valid email address prepended with `mailto:`.
21028
21021
21029
21022
`PTR`: Required. See our guide on how to [Configure Your Linode for Reverse DNS
With the exception of A, AAAA, and CAA records, this field accepts a trailing period.
21033
21026
example: 192.0.2.0
@@ -23171,7 +23164,7 @@ components:
23171
23164
23172
23165
Only used for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.
23173
23166
23174
-
The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/linux-static-ip-configuration/).
23167
+
The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/manual-network-configuration/).
23175
23168
23176
23169
Must be unique among the Linode's interfaces.
23177
23170
example: '10.0.0.1/24'
@@ -23218,7 +23211,7 @@ components:
23218
23211
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
23219
23212
you will be prompted to select a different data center or contact support.
23220
23213
23221
-
**Note:** See our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/) to view additional [limitations](/docs/guides/getting-started-with-vlans/#limitations).
23214
+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
23222
23215
LinodeRequest:
23223
23216
type: object
23224
23217
description: Common properties for creating and rebuilding Linodes.
@@ -25747,17 +25740,13 @@ components:
25747
25740
- keys_only
25748
25741
- disabled
25749
25742
description: >
25750
-
The authentication methods that are allowed when connecting to
The authentication methods that are allowed when connecting to [the Linode Shell (Lish)](/docs/guides/lish/).
25752
25744
25753
25745
* `keys_only` is the most secure if you intend to use Lish.
25754
25746
25755
-
* `disabled` is recommended if you do not intend to use Lish at
25756
-
all.
25747
+
* `disabled` is recommended if you do not intend to use Lish at all.
25757
25748
25758
-
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot
25759
-
be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request
25760
-
to the [View Profile](/docs/api/profile/#profile-view) endpoint.
25749
+
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request to the [View Profile](/docs/api/profile/#profile-view) endpoint.
25761
25750
example: keys_only
25762
25751
authorized_keys:
25763
25752
type: array
@@ -25995,7 +25984,7 @@ components:
25995
25984
images:
25996
25985
type: array
25997
25986
description: |
25998
-
An array of Image IDs. These are the Images that can be deployed with this Stackscript.
25987
+
An array of Image IDs. These are the Images that can be deployed with this StackScript.
25999
25988
26000
25989
`any/all` indicates that all available Images, including private Images, are accepted.
26001
25990
items:
@@ -26059,9 +26048,7 @@ components:
26059
26048
user_defined_fields:
26060
26049
type: array
26061
26050
description: >
26062
-
This is a list of fields defined with a special syntax inside this StackScript
26063
-
that allow for supplying customized parameters during deployment. See
26064
-
<a target="_top" href="/docs/platform/stackscripts/#variables-and-udfs">Variables and UDFs</a>
26051
+
This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs)
26065
26052
for more information.
26066
26053
items:
26067
26054
$ref: '#/components/schemas/UserDefinedField'
@@ -26302,7 +26289,7 @@ components:
26302
26289
Hello,\nI'm sorry to hear that you are having trouble resetting the
26303
26290
root password of your Linode. Just to be sure, have you tried to
26304
26291
follow the instructions in our online documentation? The link is here:\n
0 commit comments