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
@@ -1758,8 +1758,7 @@ paths:
1758
1758
description: |
1759
1759
The type of Payment Method.
1760
1760
1761
-
Alternative Payment Methods including Google Pay and PayPal can be added using Linode Cloud Manager. See our
1762
-
guide on [Managing Billing in the Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/)
1761
+
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
1763
1762
for details and instructions.
1764
1763
example: 'credit_card'
1765
1764
is_default:
@@ -2071,9 +2070,7 @@ paths:
2071
2070
- Account
2072
2071
summary: PayPal Payment Stage
2073
2072
description: |
2074
-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2075
-
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/).
2077
2074
operationId: createPayPalPayment
2078
2075
x-linode-cli-action: paypal-start
2079
2076
security:
@@ -2139,9 +2136,7 @@ paths:
2139
2136
- Account
2140
2137
summary: Staged/Approved PayPal Payment Execute
2141
2138
description: |
2142
-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2143
-
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/).
2145
2140
operationId: executePayPalPayment
2146
2141
x-linode-cli-action: paypal-execute
2147
2142
security:
@@ -2640,7 +2635,7 @@ paths:
2640
2635
description: >
2641
2636
Enables Linode Managed for the entire account and sends a welcome email to the account's associated
2642
2637
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
6789
6784
on all Linodes for new accounts created after November 5th, 2019. For more information,
6790
-
see [Sending Email on Linode](/docs/email/running-a-mail-server/#sending-email-on-linode).
6785
+
see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).
6791
6786
6792
6787
Linodes can be created in a number of ways:
6793
6788
@@ -6820,7 +6815,7 @@ paths:
6820
6815
6821
6816
* Attached to a private VLAN.
6822
6817
* Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.
6823
-
* For more information, see our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/).
6818
+
* For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).
6824
6819
6825
6820
* Create an empty Linode.
6826
6821
* The Linode will remain `offline` and must be manually started.
@@ -9755,7 +9750,7 @@ paths:
9755
9750
If the request is not authenticated, only public StackScripts are returned.
9756
9751
9757
9752
9758
-
For more information on StackScripts, please read our [StackScripts guides](/docs/platform/stackscripts/).
9753
+
For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
9759
9754
operationId: getStackScripts
9760
9755
x-linode-cli-action:
9761
9756
- list
@@ -12131,7 +12126,7 @@ paths:
12131
12126
summary: Managed SSH Key View
12132
12127
description: |
12133
12128
Returns the unique SSH public key assigned to your Linode account's
12134
-
Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account,
12129
+
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
12135
12130
Linode special forces will be able to log in to the Linode with this key
12136
12131
when attempting to resolve issues.
12137
12132
@@ -14270,7 +14265,7 @@ paths:
14270
14265
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
14271
14266
you will be prompted to select a different data center or contact support.
14272
14267
14273
-
**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).
14268
+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.
14274
14269
operationId: getVLANs
14275
14270
x-linode-cli-action:
14276
14271
- list
@@ -16589,7 +16584,7 @@ paths:
16589
16584
description: |
16590
16585
The amount of outbound data transfer used by your account's Object Storage buckets.
16591
16586
Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool.
16592
-
See the [Object Storage Pricing and Limitations](/docs/guides/pricing-and-limitations/)
16587
+
See the [Object Storage Overview](/docs/products/storage/object-storage/#pricing)
16593
16588
guide for details on Object Storage transfer quotas.
16594
16589
16595
16590
tags:
@@ -20775,7 +20770,7 @@ components:
20775
20770
description: |
20776
20771
This field is required only if the StackScript being deployed requires input
20777
20772
data from the User for successful completion. See
20778
-
[User Defined Fields (UDFs)](/docs/guides/writing-scripts-for-use-with-linode-stackscripts-a-tutorial/#user-defined-fields-udfs)
20773
+
[User Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs)
20779
20774
for more details. This field is required to be valid JSON.
20780
20775
Domain:
20781
20776
type: object
@@ -20961,9 +20956,7 @@ components:
20961
20956
- CAA
20962
20957
description: >
20963
20958
The type of Record this is in the DNS system. For example, A
20964
-
records associate a domain name with an IPv4 address, and AAAA
20965
-
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).
20967
20960
example: A
20968
20961
x-linode-filterable: true
20969
20962
x-linode-cli-display: 2
@@ -20989,7 +20982,7 @@ components:
20989
20982
`CAA`: The subdomain. Omit or enter an empty string (`""`) to apply to the entire Domain.
20990
20983
20991
20984
`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:`.
21027
21020
21028
21021
`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.
21032
21025
example: 192.0.2.0
@@ -23170,7 +23163,7 @@ components:
23170
23163
23171
23164
Only used for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.
23172
23165
23173
-
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/).
23166
+
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/).
23174
23167
23175
23168
Must be unique among the Linode's interfaces.
23176
23169
example: '10.0.0.1/24'
@@ -23217,7 +23210,7 @@ components:
23217
23210
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
23218
23211
you will be prompted to select a different data center or contact support.
23219
23212
23220
-
**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).
23213
+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
23221
23214
LinodeRequest:
23222
23215
type: object
23223
23216
description: Common properties for creating and rebuilding Linodes.
@@ -25746,17 +25739,13 @@ components:
25746
25739
- keys_only
25747
25740
- disabled
25748
25741
description: >
25749
-
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/).
25751
25743
25752
25744
* `keys_only` is the most secure if you intend to use Lish.
25753
25745
25754
-
* `disabled` is recommended if you do not intend to use Lish at
25755
-
all.
25746
+
* `disabled` is recommended if you do not intend to use Lish at all.
25756
25747
25757
-
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot
25758
-
be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request
25759
-
to the [View Profile](/docs/api/profile/#profile-view) endpoint.
25748
+
* 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.
25760
25749
example: keys_only
25761
25750
authorized_keys:
25762
25751
type: array
@@ -25994,7 +25983,7 @@ components:
25994
25983
images:
25995
25984
type: array
25996
25985
description: |
25997
-
An array of Image IDs. These are the Images that can be deployed with this Stackscript.
25986
+
An array of Image IDs. These are the Images that can be deployed with this StackScript.
25998
25987
25999
25988
`any/all` indicates that all available Images, including private Images, are accepted.
26000
25989
items:
@@ -26058,9 +26047,7 @@ components:
26058
26047
user_defined_fields:
26059
26048
type: array
26060
26049
description: >
26061
-
This is a list of fields defined with a special syntax inside this StackScript
26062
-
that allow for supplying customized parameters during deployment. See
26063
-
<a target="_top" href="/docs/platform/stackscripts/#variables-and-udfs">Variables and UDFs</a>
26050
+
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)
26064
26051
for more information.
26065
26052
items:
26066
26053
$ref: '#/components/schemas/UserDefinedField'
@@ -26301,7 +26288,7 @@ components:
26301
26288
Hello,\nI'm sorry to hear that you are having trouble resetting the
26302
26289
root password of your Linode. Just to be sure, have you tried to
26303
26290
follow the instructions in our online documentation? The link is here:\n
0 commit comments