From f23d7fd8074ce3bc97982434e0e9a6170ea7baaf Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 15 Sep 2020 16:50:21 -0400 Subject: [PATCH 1/6] updating links for new docs ui --- openapi.yaml | 232 ++++++++++++++++++++++++--------------------------- 1 file changed, 111 insertions(+), 121 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 7d0f3c9c5..d5705c3a9 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17,7 +17,7 @@ info: This document was generated from our OpenAPI Specification. See the OpenAPI website for more information. - Download the Linode OpenAPI Specification. + Download the Linode OpenAPI Specification. ## Changelog @@ -37,7 +37,7 @@ info: The easiest way to access the API is with a Personal Access Token (PAT) generated from the Linode Cloud Manager or - the [Create Personal Access Token](/api/v4/profile-tokens#post) endpoint. + the [Create Personal Access Token](/docs/api/profile/#create-personal-access-token) endpoint. All scopes for the OAuth security model ([defined below](#o-auth)) apply to this security model as well. @@ -54,9 +54,9 @@ info: If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. - 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](https://www.linode.com/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange). + 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). - Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](https://developers.linode.com/api/v4/account-oauth-clients/#post) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): + 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/#create-oauth-client) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. @@ -160,7 +160,7 @@ info: | 403 Forbidden | You are authenticated, but don't have permission to do this. | | 404 Not Found | The resource you're requesting does not exist. | | 429 Too Many Requests | You've hit a rate limit. | - | 500 Internal Server Error | Please [open a Support Ticket](/api/v4/support-tickets/#post). | + | 500 Internal Server Error | Please [open a Support Ticket](/docs/api/support/#open-support-ticket). | ## Errors @@ -170,7 +170,7 @@ info: request error might be an invalid input, a required parameter being omitted, or a malformed request. A server error means something went wrong processing your request. If this occurs, please - [open a Support Ticket](/api/v4/support-tickets/#post) + [open a Support Ticket](/docs/api/support/#open-support-ticket) and let us know. Though errors are logged and we work quickly to resolve issues, opening a ticket and providing us with reproducable steps and data is always helpful. @@ -272,7 +272,7 @@ info: | +order_by | string | Attribute to order the results by - must be filterable. | | +order | string | Either "asc" or "desc". Defaults to "asc". Requires `+order_by`. | - For example, filtering for [Linode Types](/api/v4/linode-types) + For example, filtering for [Linode Types](/docs/api/linode-types/) that offer memory equal to or higher than 61440: ```Shell @@ -286,7 +286,7 @@ info: ``` You can combine and nest operators to construct arbitrarily-complex queries. - For example, give me all [Linode Types](/api/v4/linode-types) + For example, give me all [Linode Types](/docs/api/linode-types/) which are either `standard` or `highmem` class, or have between 12 and 20 vcpus: @@ -333,30 +333,20 @@ info: `/stats` endpoints have their own dedicated limits of 100 requests per minute per user. These endpoints are: - * [View Linode Statistics](https://api.linode.com/v4/linode/instances/{linodeId}/stats) - * [View Linode Statistics (year/month)](https://api.linode.com/v4/linode/instances/{linodeId}/stats/{year}/{month}) - * [View NodeBalancer Statistics](https://api.linode.com/v4/nodebalancers/{nodeBalancerId}/stats) - * [List Managed Stats](https://api.linode.com/v4/managed/stats) + * [View Linode Statistics](/docs/api/linode-instances/#view-linode-statistics) + * [View Linode Statistics (year/month)](/docs/api/linode-instances/#view-statistics-yearmonth) + * [View NodeBalancer Statistics](/docs/api/nodebalancers/#view-nodebalancer-statistics) + * [List Managed Stats](/docs/api/managed/#list-managed-stats) Object Storage endpoints have a dedicated limit of 750 requests per second per user. - These endpoints are: + The Object Storage endpoints are: - * [List and Create Object Storage Buckets](https://developers.linode.com/api/v4/object-storage-buckets) - * [View and Remove Object Storage Buckets](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket) - * [List Object Storage Buckets in Cluster](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id) - * [Modify Object Storage Bucket Access](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-access/#post) - * [List Object Storage Bucket Contents](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-object-list) - * [Create Object Storage Object URL](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-object-url/#post) - * [List Clusters](https://developers.linode.com/api/v4/object-storage-clusters) - * [View Cluster](https://developers.linode.com/api/v4/object-storage-clusters-cluster-id) - * [List and Create Object Storage Keys](https://developers.linode.com/api/v4/object-storage-keys) - * [View, Update, and Revoke an Object Storage Key](https://developers.linode.com/api/v4/object-storage-keys-key-id) - * [Cancel Object Storage](https://developers.linode.com/api/v4/object-storage-cancel/#post) + * [Object Storage Endpoints](/docs/api/object-storage/) Opening Support Tickets has a dedicated limit of 2 requests per minute per user. That endpoint is: - * [Open Support Ticket](https://developers.linode.com/api/v4/support-tickets/#post) + * [Open Support Ticket](/docs/api/support/#open-support-ticket) ## CLI (Command Line Interface) @@ -1581,7 +1571,7 @@ paths: This begins the process of submitting a Payment via PayPal. After calling this endpoint, you must take the resulting `payment_id` along with the `payer_id` from your PayPal account and - [POST /account/payments/paypal-execute](/api/v4/account-payments-paypal-execute/#post) + [POST /account/payments/paypal-execute](/docs/api/account/#execute-stagedapproved-paypal-payment) to complete the Payment. operationId: createPayPalPayment x-linode-cli-action: paypal-start @@ -1726,7 +1716,7 @@ paths: Updates your Account settings. - To update your Longview subscription plan, send a request to [Update Longview Plan](/api/v4/longview-plan/#put). + To update your Longview subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#update-longview-plan). operationId: updateAccountSettings x-linode-cli-action: settings-update security: @@ -1772,7 +1762,7 @@ paths: description: > Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See - our [Linode Managed guide](https://linode.com/docs/platform/linode-managed/) + our [Linode Managed guide](/docs/platform/linode-managed/) to learn more. operationId: enableAccountManged x-linode-cli-action: enable-managed @@ -1927,7 +1917,7 @@ paths: description: > If true, the new User must be granted access to perform actions or access entities on this Account. See - [/account/users/{username}/grants](/api/v4/account-users-username-grants) + [/account/users/{username}/grants](/docs/api/account/#view-users-grants) for details on how to configure grants for a restricted User. example: true responses: @@ -2094,7 +2084,7 @@ paths: The current authenticated User, including the account owner, may view their - own grants at the [/profile/grants](/api/v4/profile-grants) + own grants at the [/profile/grants](/docs/api/profile/#list-grants) endpoint, but will not see entities that they do not have access to. operationId: getUserGrants x-linode-cli-action: grants @@ -3124,16 +3114,16 @@ paths: new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. See - [GET /linode/types](/api/v4/linode-types) to get more + [GET /linode/types](/docs/api/linode-types/#list-types) to get more information about each Type's specs and cost. Linodes can be created in any one of our available - [Regions](/api/v4/regions) for a list + [Regions](/docs/api/regions/#list-regions) for a list of available Regions you can deploy your Linode in. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, - see [Sending Email on Linode](https://www.linode.com/docs/email/running-a-mail-server/#sending-email-on-linode). + see [Sending Email on Linode](/docs/email/running-a-mail-server/#sending-email-on-linode). Linodes can be created in a number of ways: @@ -3144,18 +3134,18 @@ paths: * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. - * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/api/v4/profile-sshkeys/#post) for more information. + * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/docs/api/profile/#add-ssh-key) for more information. * Using a StackScript. - * See [/linode/stackscripts](/api/v4/linode-stackscripts) for + * See [/linode/stackscripts](/docs/api/stackscripts/#list-stackscripts) for a list of available StackScripts. * The Linode will be `running` after it completes `provisioning`. * Requires a compatible Image to be supplied. - * See [/linode/stackscript/{stackscriptId}](/api/v4/linode-stackscripts-stackscript-id) for compatible Images. + * See [/linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#view-stackscript) for compatible Images. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. - * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/api/v4/profile-sshkeys/#post) for more information. + * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/docs/api/profile/#add-ssh-key) for more information. * Using one of your other Linode's backups. * You must create a Linode large enough to accommodate the Backup's size. @@ -3164,7 +3154,7 @@ paths: * Create an empty Linode. * The Linode will remain `offline` and must be manually started. - * See [POST /linode/instances/{linodeId}/boot](/api/v4/linode-instances-linode-id-boot/#post). + * See [POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#boot-linode). * Disks and Configs must be created manually. * This is only recommended for advanced use cases. @@ -3197,7 +3187,7 @@ paths: A Backup ID from another Linode's available backups. Your User must have `read_write` access to that Linode, the Backup must have a `status` of `successful`, and the Linode must be deployed to the same `region` as the Backup. - See [/linode/instances/{linodeId}/backups](/api/v4/linode-instances-linode-id-backups) + See [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#list-backups) for a Linode's available backups. This field and the `image` field are mutually exclusive. @@ -3212,7 +3202,7 @@ paths: setting is `true`. See [account settings](#operaton/getAccountSettings) for more information. - Backup pricing is included in the response from [/linodes/types](/api/v4/linode-types) + Backup pricing is included in the response from [/linodes/types](/docs/api/linode-types/#list-types) swap_size: type: integer example: 512 @@ -3223,13 +3213,13 @@ paths: type: type: string description: > - The [Linode Type](/api/v4/linode-types) of the Linode + The [Linode Type](/docs/api/linode-types/#list-types) of the Linode you are creating. example: g6-standard-2 region: type: string description: > - The [Region](/api/v4/regions) where the Linode + The [Region](/docs/api/regions/#list-regions) where the Linode will be located. example: us-east image: @@ -3239,7 +3229,7 @@ paths: Images start with `linode/ `, while your Images start with `private/`. - See [/images](/api/v4/images) for more information + See [/images](/docs/api/images/) for more information on the Images available for you to use. example: linode/debian9 root_pass: @@ -3918,7 +3908,7 @@ paths: If more concurrent clones are attempted, an HTTP 400 error will be returned by this endpoint. - Any [tags](/api/v4/tags) existing on the source Linode will be cloned to the target Linode. + Any [tags](/docs/api/tags/#list-tags) existing on the source Linode will be cloned to the target Linode. tags: - Linode Instances operationId: cloneLinodeInstance @@ -3944,7 +3934,7 @@ paths: This is the Region where the Linode will be deployed. To view all available Regions you can deploy to see - [/regions](/api/v4/regions). + [/regions](/docs/api/regions/#list-regions). * Region can only be provided when cloning to a new Linode. example: us-east @@ -3957,7 +3947,7 @@ paths: `specs` on the Linode object. To view all available Linode Types you can deploy with - see [/linode/types](/api/v4/linode-types). + see [/linode/types](/docs/api/linode-types/#list-types). * Type can only be provided when cloning to a new Linode. example: g6-standard-2 @@ -3990,7 +3980,7 @@ paths: automatically be enrolled in the Linode Backup service. This will incur an additional charge. Pricing is included in the response from - [/linodes/types](/api/v4/linode-types). + [/linodes/types](/docs/api/linode-types/#list-types). * Can only be included when cloning to a new Linode. example: true @@ -4463,7 +4453,7 @@ paths: summary: Create Disk description: > Adds a new Disk to a Linode. You can optionally create a Disk - from an Image (see [/images](/api/v4/images) for a list of available public images, + from an Image (see [/images](/docs/api/images/#list-images) for a list of available public images, or use one of your own), and optionally provide a StackScript to deploy with this Disk. operationId: addLinodeDisk @@ -4918,7 +4908,7 @@ paths: Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please - [open a support ticket](/api/v4/support-tickets/#post). + [open a support ticket](/docs/api/support/#open-support-ticket). You may not add more than one private IPv4 address to a single Linode. operationId: addLinodeIP x-linode-cli-action: ip-add @@ -5186,7 +5176,7 @@ paths: description: > Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, - if any, can be accessed from [GET /account/notifications](/api/v4/account-notifications). + if any, can be accessed from [GET /account/notifications](/docs/api/account/#list-notifications). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. @@ -5194,7 +5184,7 @@ paths: To initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities - from [GET /regions](/api/v4/regions). If your Linode has a DC migration already queued + from [GET /regions](/docs/api/regions/#list-regions). If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. @@ -5221,7 +5211,7 @@ paths: description: > The region to which the Linode will be migrated. Must be a valid region slug. A list of regions can be viewed - by using the [GET /regions](/api/v4/regions) endpoint. + by using the [GET /regions](/docs/api/regions/#list-regions) endpoint. A cross data center migration will cancel a pending migration that has not yet been initiated. @@ -5343,10 +5333,10 @@ paths: description: > Resets the root password for this Linode. - * Your Linode must be [shut down](/api/v4/linode-instances-linode-id-shutdown/#post) for a password reset to complete. + * Your Linode must be [shut down](/docs/api/linode-instances/#shut-down-linode) for a password reset to complete. * If your Linode has more than one disk (not counting its swap disk), use the - [Reset Disk Root Password](/api/v4/linode-instances-linode-id-disks-disk-id-password/#post) endpoint to update a specific disk's root password. + [Reset Disk Root Password](/docs/api/linode-instances/#reset-disk-root-password) endpoint to update a specific disk's root password. * A `password_reset` event is generated when a root password reset is successful. tags: @@ -6016,7 +6006,7 @@ paths: For more information on StackScripts, please read our guide: - Automate Deployment with StackScripts. + Automate Deployment with StackScripts. operationId: getStackScripts x-linode-cli-action: list security: @@ -6251,8 +6241,8 @@ paths: description: > Returns collection of Linode Types, including pricing and specifications for each Type. These are used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. x-linode-redoc-load-ids: true operationId: getLinodeTypes @@ -6300,8 +6290,8 @@ paths: description: > Returns information about a specific Linode Type, including pricing and specifications. This is used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. operationId: getLinodeType x-linode-cli-action: type-view @@ -6380,8 +6370,8 @@ paths: Creates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the - [Kubernetes API server endpoint](/api/v4/lke-clusters-cluster-id-api-endpoint) and - the [Kubeconfig file](/api/v4/lke-clusters-cluster-id-kubeconfig) for the new cluster + [Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#list-kubernetes-api-endpoints) and + the [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#view-kubeconfig) for the new cluster are ready. requestBody: description: Configuration for the Kubernetes cluster @@ -6942,7 +6932,7 @@ paths: summary: List Kubernetes API Endpoints description: > List the Kubernetes API server endpoints for this cluster. Please note that it often takes - 2-5 minutes before the endpoint is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). + 2-5 minutes before the endpoint is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#create-kubernetes-cluster). responses: '200': description: Returns the Kubernetes API server endpoints for this cluster. @@ -7001,7 +6991,7 @@ paths: summary: View Kubeconfig description: | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before - the Kubeconfig file is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). + the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#create-kubernetes-cluster). responses: '200': description: Returns the Base64-encoded Kubeconfig file for this Kubernetes cluster. @@ -7338,7 +7328,7 @@ paths: for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free. - You must have at least one of the following `global` [User Grants](/api/v4/account-users-username-grants/) + You must have at least one of the following `global` [User Grants](/docs/api/account/#view-users-grants) in order to access this endpoint: - `"account_access": read_write` @@ -7347,7 +7337,7 @@ paths: - `"add_longview": true` - To update your subscription plan, send a request to [Update Longview Plan](/api/v4/longview-plan/#put). + To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#update-longview-plan). operationId: getLongviewPlan x-linode-cli-action: plan-view security: @@ -7381,10 +7371,10 @@ paths: You must have `"longview_subscription": true` configured as a `global` - [User Grant](/api/v4/account-users-username-grants/) in order to access this endpoint. + [User Grant](/docs/api/account/#view-users-grants) in order to access this endpoint. - You can send a request to the [List Longview Subscriptions](/api/v4/longview-subscriptions/) + You can send a request to the [List Longview Subscriptions](/docs/api/longview/#list-longview-subscriptions) endpoint to receive the details, including `id`'s, of each plan. operationId: updateLongviewPlan x-linode-cli-action: plan-update @@ -8029,7 +8019,7 @@ paths: summary: View Managed SSH Key description: > Returns the unique SSH public key assigned to your Linode account's - Managed service. If you [add this public key](https://linode.com/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account, + Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account, Linode special forces will be able to log in to the Linode with this key when attempting to resolve issues. operationId: viewManagedSSHKey @@ -8721,7 +8711,7 @@ paths: description: > Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please - [open a support ticket](/api/v4/support-tickets/#post) requesting additional + [open a support ticket](/docs/api/support/#open-support-ticket) requesting additional addresses before attempting allocation. operationId: allocateIP x-linode-cli-action: ip-add @@ -9061,7 +9051,7 @@ paths: summary: List IPv6 Pools description: > Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your - Linodes in a single [Region](https://developers.linode.com/api/v4/regions). Any Linode on your Account may bring up any address in this + Linodes in a single [Region](/docs/api/regions/#list-regions). Any Linode on your Account may bring up any address in this pool at any time, with no external configuration required. operationId: getIPv6Pools x-linode-cli-action: v6-pools @@ -9110,11 +9100,11 @@ paths: Displays the IPv6 ranges on your Account. - * An IPv6 range is a `/64` block of IPv6 addresses routed to a single Linode in a given [Region](https://developers.linode.com/api/v4/regions). + * An IPv6 range is a `/64` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#list-regions). * Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range. - * You must [open a support ticket](/api/v4/support-tickets/#post) to request a `/64` block of IPv6 addresses to be added to your account. + * You must [open a support ticket](/docs/api/support/#open-support-ticket) to request a `/64` block of IPv6 addresses to be added to your account. operationId: getIPv6Ranges x-linode-cli-action: v6-ranges security: @@ -9254,8 +9244,8 @@ paths: **Note:** When a Firewall is assigned to a Linode and you attempt - to [migrate the Linode to a data center](/api/v4/linode-instances-linode-id-migrate/#post) that does not support Cloud Firewalls, the migration will fail. - Use the [List Regions](/api/v4/regions) endpoint to view a list of a data center's capabilities. + to [migrate the Linode to a data center](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration) that does not support Cloud Firewalls, the migration will fail. + Use the [List Regions](/docs/api/regions/#list-regions) endpoint to view a list of a data center's capabilities. properties: linodes: description: > @@ -9356,7 +9346,7 @@ paths: description: | Get a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, use the - [List Firewall Devices](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#get) + [List Firewall Devices](/docs/api/networking/#list-firewall-devices) endpoint to review them. **Beta**: This endpoint is in beta. Please make sure to prepend all requests with @@ -9393,17 +9383,17 @@ paths: be manipulated by this endpoint: - A Firewall's Devices cannot be set with this endpoint. Instead, use the - [Create Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#post) - and [Delete Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#delete) + [Create Firewall Device](/docs/api/networking/#create-firewall-device) + and [Delete Firewall Device](/docs/api/networking/#delete-firewall-device) endpoints to assign and remove this Firewall from Linode services. - A Firewall's Rules cannot be changed with this endpoint. Instead, use the - [Update Firewall Rules](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-rules/#put) + [Update Firewall Rules](/docs/api/networking/#update-firewall-rules) endpoint to update your Rules. - A Firewall's status can be set to `enabled` or `disabled` by this endpoint, but it cannot be set to `deleted`. Instead, use the - [Delete Firewall](http://developers.linode.com/api/v4/networking-firewalls-firewall-id/#delete) + [Delete Firewall](/docs/api/networking/#delete-firewall) endpoint to delete a Firewall. If a Firewall's status is changed with this endpoint, a corresponding `firewall_enable` or @@ -9576,8 +9566,8 @@ paths: A `firewall_device_add` Event is generated when the Firewall Device is added successfully. **Note:** When a Firewall is assigned to a Linode and you attempt - to [migrate the Linode to a data center](/api/v4/linode-instances-linode-id-migrate/#post) that does not support Cloud Firewalls, the migration will fail. - Use the [List Regions](/api/v4/regions) endpoint to view a list of a data center's capabilities. + to [migrate the Linode to a data center](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration) that does not support Cloud Firewalls, the migration will fail. + Use the [List Regions](/docs/api/regions/#list-regions) endpoint to view a list of a data center's capabilities. **Beta**: This endpoint is in beta. Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking @@ -11630,10 +11620,10 @@ paths: before Object Storage can be cancelled: - To delete a smaller number of objects, review the instructions in our - [How to Use Object Storage](https://www.linode.com/docs/platform/object-storage/how-to-use-object-storage/) + [How to Use Object Storage](/docs/platform/object-storage/how-to-use-object-storage/) guide. - To delete large amounts of objects, consult our guide on - [Lifecycle Policies](https://www.linode.com/docs/platform/object-storage/lifecycle-policies/). + [Lifecycle Policies](/docs/platform/object-storage/lifecycle-policies/). security: - personalAccessToken: [] - oauth: @@ -11953,7 +11943,7 @@ paths: description: > Generates a Two Factor secret for your User. TFA will not be enabled until you have successfully confirmed the code you - were given with [tfa-enable-confirm](/api/v4/profile-tfa-enable-confirm/#post) (see below). + were given with [tfa-enable-confirm](/docs/api/profile/#create-two-factor-secret) (see below). Once enabled, logins from untrusted computers will be required to provide a TFA code before they are successful. operationId: tfaEnable @@ -14311,7 +14301,7 @@ components: readOnly: true description: > The Longview Pro tier you are currently subscribed to. The value must be - a [Longview Subscription](/api/v4/longview-subscriptions) + a [Longview Subscription](/docs/api/longview/#list-longview-subscriptions) ID or `null` for Longview Free. example: longview-3 x-linode-cli-display: 2 @@ -14674,7 +14664,7 @@ components: An Image ID to deploy the Disk from. Official Linode Images start with `linode/ `, while your Images start with `private/`. - See [/images](/api/v4/images) for more information on the Images available for you to use. + See [/images](/docs/api/images/#list-images) for more information on the Images available for you to use. example: linode/debian9 authorized_keys: type: array @@ -14715,7 +14705,7 @@ components: A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. A compatible `image` is required to use a StackScript. To get a list of available StackScript and their permitted Images - see [/stackscripts](/api/v4/linode-stackscripts). + see [/stackscripts](/docs/api/stackscripts/#list-stackscripts). This field cannot be used when deploying from a Backup or a private Image. stackscript_data: type: object @@ -14724,7 +14714,7 @@ components: description: | This field is required only if the StackScript being deployed requires input data from the User for successful completion. See - Variables and UDFs + Variables and UDFs for more details. This field is required to be valid JSON. Domain: type: object @@ -14995,7 +14985,7 @@ components: description: > What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to - [open a Support Ticket](/api/v4/support-tickets/#post) or perform some + [open a Support Ticket](/docs/api/support/#open-support-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value field: @@ -15322,7 +15312,7 @@ components: description: > A resource that controls incoming and outgoing network traffic to a Linode service. A Firewall can be assigned to multiple Linode services, and up to three active Firewalls can be assigned to a single Linode service. - [Create a Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#post) + [Create a Firewall Device](/docs/api/networking/#create-firewall) to assign a Firewall to a Linode service. Currently, Firewalls can only be assigned to Linode instances. properties: id: @@ -15375,8 +15365,8 @@ components: The status of this Firewall. * When a Firewall is first created its status is `enabled`. - * Use the [Update Firewall](/api/v4/networking-firewalls-firewall-id/#put) endpoint to set a Firewall's status to `enbaled` or `disabled`. - * Use the [Delete Firewall](/api/v4/networking-firewalls-firewall-id/#delete) endpoint to delete a Firewall. + * Use the [Update Firewall](/docs/api/networking/#update-firewall) endpoint to set a Firewall's status to `enbaled` or `disabled`. + * Use the [Delete Firewall](/docs/api/networking/#delete-firewall) endpoint to delete a Firewall. enum: - enabled - disabled @@ -16048,7 +16038,7 @@ components: The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the - [/networking/ipv4/assign](/api/v4/networking-ipv-4-assign/#post) + [/networking/ipv4/assign](/docs/api/networking/#assign-ips-to-linodes) endpoint. For SLAAC and link-local addresses, this value may not be changed. example: 123 readOnly: true @@ -16402,7 +16392,7 @@ components: readOnly: true description: > This is the location where the Linode was deployed. A Linode's region can only be changed by - initiating a [cross data center migration](/api/v4/linode-instances-linode-id-migrate/#post). + initiating a [cross data center migration](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration). x-linode-cli-display: 4 image: x-linode-filterable: true @@ -16414,11 +16404,11 @@ components: type: readOnly: true description: > - This is the [Linode Type](/api/v4/linode-types) that this + This is the [Linode Type](/docs/api/linode-types/#list-types) that this Linode was deployed with. To change a Linode's Type, use - [POST /linode/instances/{linodeId}/resize](/api/v4/linode-instances-linode-id-resize/#post). + [POST /linode/instances/{linodeId}/resize](/docs/api/linode-instances/#resize-linode). x-linode-cli-display: 5 group: deprecated: true @@ -16502,7 +16492,7 @@ components: description: | This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address upon creation, and may get a single private IPv4 address if needed. You may need to - [open a support ticket](/api/v4/support-tickets/#post) + [open a support ticket](/docs/api/support/#open-support-ticket) to get additional IPv4 addresses. IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. @@ -16528,10 +16518,10 @@ components: will divide this space between a primary disk with an `image` deployed to it, and a swap disk, usually 512 MB. This is the default configuration created when deploying a Linode with an `image` through - [POST /linode/instances](/api/v4/linode-instances/#post). + [POST /linode/instances](/docs/api/linode-instances/#create-linode). While this configuration is suitable for 99% of use cases, if you need finer control over your Linode's disks, see the - [/linode/instances/{linodeId}/disks](/api/v4/linode-instances-linode-id-disks) + [/linode/instances/{linodeId}/disks](/docs/api/linode-instances/#list-disks) endpoints. example: 81920 readOnly: true @@ -16541,7 +16531,7 @@ components: The amount of RAM, in MB, this Linode has access to. Typically a Linode will choose to boot with all of its available RAM, but this can be configured in a Config profile, see the - [/linode/instances/{linodeId}/configs](/api/v4/linode-instances-linode-id-configs) + [/linode/instances/{linodeId}/configs](/docs/api/linode-instances/#list-configuration-profiles) endpoints and the LinodeConfig object for more information. example: 4096 readOnly: true @@ -16552,7 +16542,7 @@ components: Typically a Linode will choose to boot with all of its available vcpus, but this can be configured in a Config Profile, see the - [/linode/instances/{linodeId}/configs](/api/v4/linode-instances-linode-id-configs) + [/linode/instances/{linodeId}/configs](/docs/api/linode-instances/#list-configuration-profiles) endpoints and the LinodeConfig object for more information. example: 2 readOnly: true @@ -16611,13 +16601,13 @@ components: type: object description: > Information about this Linode's backups status. For information about available - backups, see [/linode/instances/{linodeId}/backups](/api/v4/linode-instances-linode-id-backups). + backups, see [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#list-backups). properties: enabled: type: boolean description: > If this Linode has the Backup service enabled. To enable backups, see - [POST /linode/instances/{linodeId}/backups/enable](/api/v4/linode-instances-linode-id-backups-enable/#post). + [POST /linode/instances/{linodeId}/backups/enable](/docs/api/linode-instances/#enable-backups). example: true readOnly: true schedule: @@ -16986,8 +16976,8 @@ components: description: > Returns collection of Linode types, including pricing and specifications for each type. These are used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. properties: id: @@ -17106,7 +17096,7 @@ components: readOnly: true nullable: true description: > - The Linode Type that a [mutate](/api/v4/linode-instances-linode-id-mutate/#post) + The Linode Type that a [mutate](/docs/api/linode-instances/#upgrade-linode) will upgrade to for a Linode of this type. If "null", a Linode of this type may not mutate. example: null @@ -17503,7 +17493,7 @@ components: The subscription ID for a particular Longview plan. A value of `null` corresponds to Longview Free. - You can send a request to the [List Longview Subscriptions](/api/v4/longview-subscriptions/) + You can send a request to the [List Longview Subscriptions](/docs/api/longview/#list-longview-subscriptions) endpoint to receive the details of each plan. example: longview-10 x-linode-cli-display: 1 @@ -18749,9 +18739,9 @@ components: Limited Access Keys can: - * [list all buckets](/api/v4/object-storage-buckets/) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket. + * [list all buckets](/docs/api/object-storage/#list-object-storage-buckets) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket. - * [create new buckets](/api/v4/object-storage-buckets/#post), but do not have any access to the buckets it creates, unless explicitly given access to them. + * [create new buckets](/docs/api/object-storage/#create-object-storage-bucket), but do not have any access to the buckets it creates, unless explicitly given access to them. items: type: object properties: @@ -19057,7 +19047,7 @@ components: - disabled description: > The authentication methods that are allowed when connecting to - [the Linode Shell (Lish)](https://www.linode.com/docs/platform/manager/using-the-linode-shell-lish/). + [the Linode Shell (Lish)](/docs/platform/manager/using-the-linode-shell-lish/). * `keys_only` is the most secure if you intend to use Lish. @@ -19066,7 +19056,7 @@ components: * 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](/api/v4/profile) endpoint. + to the [View Profile](/docs/api/profile/#view-profile) endpoint. example: keys_only authorized_keys: type: array @@ -19082,7 +19072,7 @@ components: type: boolean description: > If true, logins from untrusted computers will require Two Factor - Authentication. See [/profile/tfa-enable](/api/v4/profile-tfa-enable/#post) to + Authentication. See [/profile/tfa-enable](/docs/api/profile/#create-two-factor-secret) to enable Two Factor Authentication. example: true x-linode-cli-display: 4 @@ -19091,7 +19081,7 @@ components: description: > If true, your User has restrictions on what can be accessed on your Account. To get details on what entities/actions you can - access/perform, see [/profile/grants](/api/v4/profile-grants). + access/perform, see [/profile/grants](/docs/api/profile/#list-grants). example: false x-linode-cli-display: 3 authentication_type: @@ -19296,7 +19286,7 @@ components: description: > This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See - Variables and UDFs + Variables and UDFs for more information. items: $ref: '#/components/schemas/UserDefinedField' @@ -19612,7 +19602,7 @@ components: * No ID attributes (i.e. `linode_id`, `domain_id`, etc.) should be provided with this request. - * Your account must have a [Managed service enabled](/api/v4/managed-services-service-id-enable/#post). + * Your account must have a [Managed service enabled](/docs/api/managed/#enable-managed-service). example: false volume_id: type: integer @@ -19690,7 +19680,7 @@ components: description: > If true, this User must be granted access to perform actions or access entities on this Account. See - [/account/users/{username}/grants](/api/v4/account-users-username-grants) + [/account/users/{username}/grants](/docs/api/account/#view-users-grants) for details on how to configure grants for a restricted User. example: true x-linode-cli-display: 3 @@ -19701,9 +19691,9 @@ components: description: > A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the `authorized_users` - field of a [create Linode](/api/v4/linode-instances/#post), - [rebuild Linode](/api/v4/linode-instances-linode-id-rebuild/#post), - or [create Disk](/api/v4/linode-instances-linode-id-disks/#post) request. + field of a [create Linode](/docs/api/linode-instances/#create-linode), + [rebuild Linode](/docs/api/linode-instances/#rebuild-linode), + or [create Disk](/docs/api/linode-instances/#create-disk) request. example: - home-pc - laptop @@ -19712,7 +19702,7 @@ components: readOnly: true description: > A boolean value indicating if the User has Two Factor Authentication (TFA) - enabled. See the Create Two Factor Secret ([/profile/tfa-enable](/api/v4/profile-tfa-enable/#post)) + enabled. See the Create Two Factor Secret ([/profile/tfa-enable](/docs/api/profile/#create-two-factor-secret)) endpoint to enable TFA. UserDefinedField: type: object @@ -19900,7 +19890,7 @@ components: * `resizing` - the Volume is in the process of upgrading its current capacity. * `contact_support` - there is a problem with your Volume. Please - [open a Support Ticket](/api/v4/support-tickets/#post) to resolve the issue. + [open a Support Ticket](/docs/api/support/#open-support-ticket) to resolve the issue. enum: - creating - active From 17d029a337ccfe5693687198afaa3fa8f4cbd5e2 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 15 Sep 2020 16:50:21 -0400 Subject: [PATCH 2/6] updating links for new docs ui --- openapi.yaml | 232 ++++++++++++++++++++++++--------------------------- 1 file changed, 111 insertions(+), 121 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 3edd095fb..f909238d6 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17,7 +17,7 @@ info: This document was generated from our OpenAPI Specification. See the OpenAPI website for more information. - Download the Linode OpenAPI Specification. + Download the Linode OpenAPI Specification. ## Changelog @@ -37,7 +37,7 @@ info: The easiest way to access the API is with a Personal Access Token (PAT) generated from the Linode Cloud Manager or - the [Create Personal Access Token](/api/v4/profile-tokens#post) endpoint. + the [Create Personal Access Token](/docs/api/profile/#create-personal-access-token) endpoint. All scopes for the OAuth security model ([defined below](#o-auth)) apply to this security model as well. @@ -54,9 +54,9 @@ info: If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. - 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](https://www.linode.com/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange). + 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). - Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](https://developers.linode.com/api/v4/account-oauth-clients/#post) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): + 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/#create-oauth-client) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. @@ -160,7 +160,7 @@ info: | 403 Forbidden | You are authenticated, but don't have permission to do this. | | 404 Not Found | The resource you're requesting does not exist. | | 429 Too Many Requests | You've hit a rate limit. | - | 500 Internal Server Error | Please [open a Support Ticket](/api/v4/support-tickets/#post). | + | 500 Internal Server Error | Please [open a Support Ticket](/docs/api/support/#open-support-ticket). | ## Errors @@ -170,7 +170,7 @@ info: request error might be an invalid input, a required parameter being omitted, or a malformed request. A server error means something went wrong processing your request. If this occurs, please - [open a Support Ticket](/api/v4/support-tickets/#post) + [open a Support Ticket](/docs/api/support/#open-support-ticket) and let us know. Though errors are logged and we work quickly to resolve issues, opening a ticket and providing us with reproducable steps and data is always helpful. @@ -272,7 +272,7 @@ info: | +order_by | string | Attribute to order the results by - must be filterable. | | +order | string | Either "asc" or "desc". Defaults to "asc". Requires `+order_by`. | - For example, filtering for [Linode Types](/api/v4/linode-types) + For example, filtering for [Linode Types](/docs/api/linode-types/) that offer memory equal to or higher than 61440: ```Shell @@ -286,7 +286,7 @@ info: ``` You can combine and nest operators to construct arbitrarily-complex queries. - For example, give me all [Linode Types](/api/v4/linode-types) + For example, give me all [Linode Types](/docs/api/linode-types/) which are either `standard` or `highmem` class, or have between 12 and 20 vcpus: @@ -333,30 +333,20 @@ info: `/stats` endpoints have their own dedicated limits of 100 requests per minute per user. These endpoints are: - * [View Linode Statistics](https://api.linode.com/v4/linode/instances/{linodeId}/stats) - * [View Linode Statistics (year/month)](https://api.linode.com/v4/linode/instances/{linodeId}/stats/{year}/{month}) - * [View NodeBalancer Statistics](https://api.linode.com/v4/nodebalancers/{nodeBalancerId}/stats) - * [List Managed Stats](https://api.linode.com/v4/managed/stats) + * [View Linode Statistics](/docs/api/linode-instances/#view-linode-statistics) + * [View Linode Statistics (year/month)](/docs/api/linode-instances/#view-statistics-yearmonth) + * [View NodeBalancer Statistics](/docs/api/nodebalancers/#view-nodebalancer-statistics) + * [List Managed Stats](/docs/api/managed/#list-managed-stats) Object Storage endpoints have a dedicated limit of 750 requests per second per user. - These endpoints are: + The Object Storage endpoints are: - * [List and Create Object Storage Buckets](https://developers.linode.com/api/v4/object-storage-buckets) - * [View and Remove Object Storage Buckets](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket) - * [List Object Storage Buckets in Cluster](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id) - * [Modify Object Storage Bucket Access](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-access/#post) - * [List Object Storage Bucket Contents](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-object-list) - * [Create Object Storage Object URL](https://developers.linode.com/api/v4/object-storage-buckets-cluster-id-bucket-object-url/#post) - * [List Clusters](https://developers.linode.com/api/v4/object-storage-clusters) - * [View Cluster](https://developers.linode.com/api/v4/object-storage-clusters-cluster-id) - * [List and Create Object Storage Keys](https://developers.linode.com/api/v4/object-storage-keys) - * [View, Update, and Revoke an Object Storage Key](https://developers.linode.com/api/v4/object-storage-keys-key-id) - * [Cancel Object Storage](https://developers.linode.com/api/v4/object-storage-cancel/#post) + * [Object Storage Endpoints](/docs/api/object-storage/) Opening Support Tickets has a dedicated limit of 2 requests per minute per user. That endpoint is: - * [Open Support Ticket](https://developers.linode.com/api/v4/support-tickets/#post) + * [Open Support Ticket](/docs/api/support/#open-support-ticket) ## CLI (Command Line Interface) @@ -1581,7 +1571,7 @@ paths: This begins the process of submitting a Payment via PayPal. After calling this endpoint, you must take the resulting `payment_id` along with the `payer_id` from your PayPal account and - [POST /account/payments/paypal-execute](/api/v4/account-payments-paypal-execute/#post) + [POST /account/payments/paypal-execute](/docs/api/account/#execute-stagedapproved-paypal-payment) to complete the Payment. operationId: createPayPalPayment x-linode-cli-action: paypal-start @@ -1726,7 +1716,7 @@ paths: Updates your Account settings. - To update your Longview subscription plan, send a request to [Update Longview Plan](/api/v4/longview-plan/#put). + To update your Longview subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#update-longview-plan). operationId: updateAccountSettings x-linode-cli-action: settings-update security: @@ -1772,7 +1762,7 @@ paths: description: > Enables Linode Managed for the entire account and sends a welcome email to the account's associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See - our [Linode Managed guide](https://linode.com/docs/platform/linode-managed/) + our [Linode Managed guide](/docs/platform/linode-managed/) to learn more. operationId: enableAccountManged x-linode-cli-action: enable-managed @@ -1927,7 +1917,7 @@ paths: description: > If true, the new User must be granted access to perform actions or access entities on this Account. See - [/account/users/{username}/grants](/api/v4/account-users-username-grants) + [/account/users/{username}/grants](/docs/api/account/#view-users-grants) for details on how to configure grants for a restricted User. example: true responses: @@ -2094,7 +2084,7 @@ paths: The current authenticated User, including the account owner, may view their - own grants at the [/profile/grants](/api/v4/profile-grants) + own grants at the [/profile/grants](/docs/api/profile/#list-grants) endpoint, but will not see entities that they do not have access to. operationId: getUserGrants x-linode-cli-action: grants @@ -3124,16 +3114,16 @@ paths: new Linode will incur a charge on your Account. Linodes can be created using one of the available Types. See - [GET /linode/types](/api/v4/linode-types) to get more + [GET /linode/types](/docs/api/linode-types/#list-types) to get more information about each Type's specs and cost. Linodes can be created in any one of our available - [Regions](/api/v4/regions) for a list + [Regions](/docs/api/regions/#list-regions) for a list of available Regions you can deploy your Linode in. In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587 on all Linodes for new accounts created after November 5th, 2019. For more information, - see [Sending Email on Linode](https://www.linode.com/docs/email/running-a-mail-server/#sending-email-on-linode). + see [Sending Email on Linode](/docs/email/running-a-mail-server/#sending-email-on-linode). Linodes can be created in a number of ways: @@ -3144,18 +3134,18 @@ paths: * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. - * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/api/v4/profile-sshkeys/#post) for more information. + * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/docs/api/profile/#add-ssh-key) for more information. * Using a StackScript. - * See [/linode/stackscripts](/api/v4/linode-stackscripts) for + * See [/linode/stackscripts](/docs/api/stackscripts/#list-stackscripts) for a list of available StackScripts. * The Linode will be `running` after it completes `provisioning`. * Requires a compatible Image to be supplied. - * See [/linode/stackscript/{stackscriptId}](/api/v4/linode-stackscripts-stackscript-id) for compatible Images. + * See [/linode/stackscript/{stackscriptId}](/docs/api/stackscripts/#view-stackscript) for compatible Images. * Requires a `root_pass` be supplied to use for the root User's Account. * It is recommended to supply SSH keys for the root User using the `authorized_keys` field. * You may also supply a list of usernames via the `authorized_users` field. - * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/api/v4/profile-sshkeys/#post) for more information. + * These users must have an SSH Key associated with your Profile first. See [/profile/sshkeys](/docs/api/profile/#add-ssh-key) for more information. * Using one of your other Linode's backups. * You must create a Linode large enough to accommodate the Backup's size. @@ -3164,7 +3154,7 @@ paths: * Create an empty Linode. * The Linode will remain `offline` and must be manually started. - * See [POST /linode/instances/{linodeId}/boot](/api/v4/linode-instances-linode-id-boot/#post). + * See [POST /linode/instances/{linodeId}/boot](/docs/api/linode-instances/#boot-linode). * Disks and Configs must be created manually. * This is only recommended for advanced use cases. @@ -3197,7 +3187,7 @@ paths: A Backup ID from another Linode's available backups. Your User must have `read_write` access to that Linode, the Backup must have a `status` of `successful`, and the Linode must be deployed to the same `region` as the Backup. - See [/linode/instances/{linodeId}/backups](/api/v4/linode-instances-linode-id-backups) + See [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#list-backups) for a Linode's available backups. This field and the `image` field are mutually exclusive. @@ -3212,7 +3202,7 @@ paths: setting is `true`. See [account settings](#operaton/getAccountSettings) for more information. - Backup pricing is included in the response from [/linodes/types](/api/v4/linode-types) + Backup pricing is included in the response from [/linodes/types](/docs/api/linode-types/#list-types) swap_size: type: integer example: 512 @@ -3223,13 +3213,13 @@ paths: type: type: string description: > - The [Linode Type](/api/v4/linode-types) of the Linode + The [Linode Type](/docs/api/linode-types/#list-types) of the Linode you are creating. example: g6-standard-2 region: type: string description: > - The [Region](/api/v4/regions) where the Linode + The [Region](/docs/api/regions/#list-regions) where the Linode will be located. example: us-east image: @@ -3239,7 +3229,7 @@ paths: Images start with `linode/ `, while your Images start with `private/`. - See [/images](/api/v4/images) for more information + See [/images](/docs/api/images/) for more information on the Images available for you to use. example: linode/debian9 root_pass: @@ -3918,7 +3908,7 @@ paths: If more concurrent clones are attempted, an HTTP 400 error will be returned by this endpoint. - Any [tags](/api/v4/tags) existing on the source Linode will be cloned to the target Linode. + Any [tags](/docs/api/tags/#list-tags) existing on the source Linode will be cloned to the target Linode. tags: - Linode Instances operationId: cloneLinodeInstance @@ -3944,7 +3934,7 @@ paths: This is the Region where the Linode will be deployed. To view all available Regions you can deploy to see - [/regions](/api/v4/regions). + [/regions](/docs/api/regions/#list-regions). * Region can only be provided when cloning to a new Linode. example: us-east @@ -3957,7 +3947,7 @@ paths: `specs` on the Linode object. To view all available Linode Types you can deploy with - see [/linode/types](/api/v4/linode-types). + see [/linode/types](/docs/api/linode-types/#list-types). * Type can only be provided when cloning to a new Linode. example: g6-standard-2 @@ -3990,7 +3980,7 @@ paths: automatically be enrolled in the Linode Backup service. This will incur an additional charge. Pricing is included in the response from - [/linodes/types](/api/v4/linode-types). + [/linodes/types](/docs/api/linode-types/#list-types). * Can only be included when cloning to a new Linode. example: true @@ -4463,7 +4453,7 @@ paths: summary: Create Disk description: > Adds a new Disk to a Linode. You can optionally create a Disk - from an Image (see [/images](/api/v4/images) for a list of available public images, + from an Image (see [/images](/docs/api/images/#list-images) for a list of available public images, or use one of your own), and optionally provide a StackScript to deploy with this Disk. operationId: addLinodeDisk @@ -4918,7 +4908,7 @@ paths: Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please - [open a support ticket](/api/v4/support-tickets/#post). + [open a support ticket](/docs/api/support/#open-support-ticket). You may not add more than one private IPv4 address to a single Linode. operationId: addLinodeIP x-linode-cli-action: ip-add @@ -5186,7 +5176,7 @@ paths: description: > Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration. A list of pending migrations, - if any, can be accessed from [GET /account/notifications](/api/v4/account-notifications). + if any, can be accessed from [GET /account/notifications](/docs/api/account/#list-notifications). When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. @@ -5194,7 +5184,7 @@ paths: To initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities - from [GET /regions](/api/v4/regions). If your Linode has a DC migration already queued + from [GET /regions](/docs/api/regions/#list-regions). If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. @@ -5221,7 +5211,7 @@ paths: description: > The region to which the Linode will be migrated. Must be a valid region slug. A list of regions can be viewed - by using the [GET /regions](/api/v4/regions) endpoint. + by using the [GET /regions](/docs/api/regions/#list-regions) endpoint. A cross data center migration will cancel a pending migration that has not yet been initiated. @@ -5343,10 +5333,10 @@ paths: description: > Resets the root password for this Linode. - * Your Linode must be [shut down](/api/v4/linode-instances-linode-id-shutdown/#post) for a password reset to complete. + * Your Linode must be [shut down](/docs/api/linode-instances/#shut-down-linode) for a password reset to complete. * If your Linode has more than one disk (not counting its swap disk), use the - [Reset Disk Root Password](/api/v4/linode-instances-linode-id-disks-disk-id-password/#post) endpoint to update a specific disk's root password. + [Reset Disk Root Password](/docs/api/linode-instances/#reset-disk-root-password) endpoint to update a specific disk's root password. * A `password_reset` event is generated when a root password reset is successful. tags: @@ -6016,7 +6006,7 @@ paths: For more information on StackScripts, please read our guide: - Automate Deployment with StackScripts. + Automate Deployment with StackScripts. operationId: getStackScripts x-linode-cli-action: list security: @@ -6251,8 +6241,8 @@ paths: description: > Returns collection of Linode Types, including pricing and specifications for each Type. These are used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. x-linode-redoc-load-ids: true operationId: getLinodeTypes @@ -6300,8 +6290,8 @@ paths: description: > Returns information about a specific Linode Type, including pricing and specifications. This is used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. operationId: getLinodeType x-linode-cli-action: type-view @@ -6380,8 +6370,8 @@ paths: Creates a Kubernetes cluster. The Kubernetes cluster will be created asynchronously. You can use the events system to determine when the Kubernetes cluster is ready to use. Please note that it often takes 2-5 minutes before the - [Kubernetes API server endpoint](/api/v4/lke-clusters-cluster-id-api-endpoint) and - the [Kubeconfig file](/api/v4/lke-clusters-cluster-id-kubeconfig) for the new cluster + [Kubernetes API server endpoint](/docs/api/linode-kubernetes-engine-lke/#list-kubernetes-api-endpoints) and + the [Kubeconfig file](/docs/api/linode-kubernetes-engine-lke/#view-kubeconfig) for the new cluster are ready. requestBody: description: Configuration for the Kubernetes cluster @@ -6942,7 +6932,7 @@ paths: summary: List Kubernetes API Endpoints description: > List the Kubernetes API server endpoints for this cluster. Please note that it often takes - 2-5 minutes before the endpoint is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). + 2-5 minutes before the endpoint is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#create-kubernetes-cluster). responses: '200': description: Returns the Kubernetes API server endpoints for this cluster. @@ -7001,7 +6991,7 @@ paths: summary: View Kubeconfig description: | Get the Kubeconfig file for a Cluster. Please note that it often takes 2-5 minutes before - the Kubeconfig file is ready after first [creating a new cluster](/api/v4/lke-clusters/#post). + the Kubeconfig file is ready after first [creating a new cluster](/docs/api/linode-kubernetes-engine-lke/#create-kubernetes-cluster). responses: '200': description: Returns the Base64-encoded Kubeconfig file for this Kubernetes cluster. @@ -7338,7 +7328,7 @@ paths: for your current Longview Pro plan, or an empty set `{}` if your current plan is Longview Free. - You must have at least one of the following `global` [User Grants](/api/v4/account-users-username-grants/) + You must have at least one of the following `global` [User Grants](/docs/api/account/#view-users-grants) in order to access this endpoint: - `"account_access": read_write` @@ -7347,7 +7337,7 @@ paths: - `"add_longview": true` - To update your subscription plan, send a request to [Update Longview Plan](/api/v4/longview-plan/#put). + To update your subscription plan, send a request to [Update Longview Plan](/docs/api/longview/#update-longview-plan). operationId: getLongviewPlan x-linode-cli-action: plan-view security: @@ -7381,10 +7371,10 @@ paths: You must have `"longview_subscription": true` configured as a `global` - [User Grant](/api/v4/account-users-username-grants/) in order to access this endpoint. + [User Grant](/docs/api/account/#view-users-grants) in order to access this endpoint. - You can send a request to the [List Longview Subscriptions](/api/v4/longview-subscriptions/) + You can send a request to the [List Longview Subscriptions](/docs/api/longview/#list-longview-subscriptions) endpoint to receive the details, including `id`'s, of each plan. operationId: updateLongviewPlan x-linode-cli-action: plan-update @@ -8029,7 +8019,7 @@ paths: summary: View Managed SSH Key description: > Returns the unique SSH public key assigned to your Linode account's - Managed service. If you [add this public key](https://linode.com/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account, + Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account, Linode special forces will be able to log in to the Linode with this key when attempting to resolve issues. operationId: viewManagedSSHKey @@ -8721,7 +8711,7 @@ paths: description: > Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please - [open a support ticket](/api/v4/support-tickets/#post) requesting additional + [open a support ticket](/docs/api/support/#open-support-ticket) requesting additional addresses before attempting allocation. operationId: allocateIP x-linode-cli-action: ip-add @@ -9061,7 +9051,7 @@ paths: summary: List IPv6 Pools description: > Displays the IPv6 pools on your Account. A pool of IPv6 addresses are routed to all of your - Linodes in a single [Region](https://developers.linode.com/api/v4/regions). Any Linode on your Account may bring up any address in this + Linodes in a single [Region](/docs/api/regions/#list-regions). Any Linode on your Account may bring up any address in this pool at any time, with no external configuration required. operationId: getIPv6Pools x-linode-cli-action: v6-pools @@ -9110,11 +9100,11 @@ paths: Displays the IPv6 ranges on your Account. - * An IPv6 range is a `/64` block of IPv6 addresses routed to a single Linode in a given [Region](https://developers.linode.com/api/v4/regions). + * An IPv6 range is a `/64` block of IPv6 addresses routed to a single Linode in a given [Region](/docs/api/regions/#list-regions). * Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range. - * You must [open a support ticket](/api/v4/support-tickets/#post) to request a `/64` block of IPv6 addresses to be added to your account. + * You must [open a support ticket](/docs/api/support/#open-support-ticket) to request a `/64` block of IPv6 addresses to be added to your account. operationId: getIPv6Ranges x-linode-cli-action: v6-ranges security: @@ -9269,8 +9259,8 @@ paths: **Note:** When a Firewall is assigned to a Linode and you attempt - to [migrate the Linode to a data center](/api/v4/linode-instances-linode-id-migrate/#post) that does not support Cloud Firewalls, the migration will fail. - Use the [List Regions](/api/v4/regions) endpoint to view a list of a data center's capabilities. + to [migrate the Linode to a data center](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration) that does not support Cloud Firewalls, the migration will fail. + Use the [List Regions](/docs/api/regions/#list-regions) endpoint to view a list of a data center's capabilities. properties: linodes: description: > @@ -9371,7 +9361,7 @@ paths: description: | Get a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, use the - [List Firewall Devices](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#get) + [List Firewall Devices](/docs/api/networking/#list-firewall-devices) endpoint to review them. This endpoint is in **beta**. @@ -9413,17 +9403,17 @@ paths: be manipulated by this endpoint: - A Firewall's Devices cannot be set with this endpoint. Instead, use the - [Create Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#post) - and [Delete Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#delete) + [Create Firewall Device](/docs/api/networking/#create-firewall-device) + and [Delete Firewall Device](/docs/api/networking/#delete-firewall-device) endpoints to assign and remove this Firewall from Linode services. - A Firewall's Rules cannot be changed with this endpoint. Instead, use the - [Update Firewall Rules](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-rules/#put) + [Update Firewall Rules](/docs/api/networking/#update-firewall-rules) endpoint to update your Rules. - A Firewall's status can be set to `enabled` or `disabled` by this endpoint, but it cannot be set to `deleted`. Instead, use the - [Delete Firewall](http://developers.linode.com/api/v4/networking-firewalls-firewall-id/#delete) + [Delete Firewall](/docs/api/networking/#delete-firewall) endpoint to delete a Firewall. If a Firewall's status is changed with this endpoint, a corresponding `firewall_enable` or @@ -9613,8 +9603,8 @@ paths: A `firewall_device_add` Event is generated when the Firewall Device is added successfully. **Note:** When a Firewall is assigned to a Linode and you attempt - to [migrate the Linode to a data center](/api/v4/linode-instances-linode-id-migrate/#post) that does not support Cloud Firewalls, the migration will fail. - Use the [List Regions](/api/v4/regions) endpoint to view a list of a data center's capabilities. + to [migrate the Linode to a data center](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration) that does not support Cloud Firewalls, the migration will fail. + Use the [List Regions](/docs/api/regions/#list-regions) endpoint to view a list of a data center's capabilities. This endpoint is in **beta**. @@ -11689,10 +11679,10 @@ paths: before Object Storage can be cancelled: - To delete a smaller number of objects, review the instructions in our - [How to Use Object Storage](https://www.linode.com/docs/platform/object-storage/how-to-use-object-storage/) + [How to Use Object Storage](/docs/platform/object-storage/how-to-use-object-storage/) guide. - To delete large amounts of objects, consult our guide on - [Lifecycle Policies](https://www.linode.com/docs/platform/object-storage/lifecycle-policies/). + [Lifecycle Policies](/docs/platform/object-storage/lifecycle-policies/). security: - personalAccessToken: [] - oauth: @@ -12012,7 +12002,7 @@ paths: description: > Generates a Two Factor secret for your User. TFA will not be enabled until you have successfully confirmed the code you - were given with [tfa-enable-confirm](/api/v4/profile-tfa-enable-confirm/#post) (see below). + were given with [tfa-enable-confirm](/docs/api/profile/#create-two-factor-secret) (see below). Once enabled, logins from untrusted computers will be required to provide a TFA code before they are successful. operationId: tfaEnable @@ -14370,7 +14360,7 @@ components: readOnly: true description: > The Longview Pro tier you are currently subscribed to. The value must be - a [Longview Subscription](/api/v4/longview-subscriptions) + a [Longview Subscription](/docs/api/longview/#list-longview-subscriptions) ID or `null` for Longview Free. example: longview-3 x-linode-cli-display: 2 @@ -14733,7 +14723,7 @@ components: An Image ID to deploy the Disk from. Official Linode Images start with `linode/ `, while your Images start with `private/`. - See [/images](/api/v4/images) for more information on the Images available for you to use. + See [/images](/docs/api/images/#list-images) for more information on the Images available for you to use. example: linode/debian9 authorized_keys: type: array @@ -14774,7 +14764,7 @@ components: A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode. A compatible `image` is required to use a StackScript. To get a list of available StackScript and their permitted Images - see [/stackscripts](/api/v4/linode-stackscripts). + see [/stackscripts](/docs/api/stackscripts/#list-stackscripts). This field cannot be used when deploying from a Backup or a private Image. stackscript_data: type: object @@ -14783,7 +14773,7 @@ components: description: | This field is required only if the StackScript being deployed requires input data from the User for successful completion. See - Variables and UDFs + Variables and UDFs for more details. This field is required to be valid JSON. Domain: type: object @@ -15054,7 +15044,7 @@ components: description: > What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to - [open a Support Ticket](/api/v4/support-tickets/#post) or perform some + [open a Support Ticket](/docs/api/support/#open-support-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value field: @@ -15381,7 +15371,7 @@ components: description: > A resource that controls incoming and outgoing network traffic to a Linode service. A Firewall can be assigned to multiple Linode services, and up to three active Firewalls can be assigned to a single Linode service. - [Create a Firewall Device](http://developers.linode.com/api/v4/networking-firewalls-firewall-id-devices/#post) + [Create a Firewall Device](/docs/api/networking/#create-firewall) to assign a Firewall to a Linode service. Currently, Firewalls can only be assigned to Linode instances. properties: id: @@ -15434,8 +15424,8 @@ components: The status of this Firewall. * When a Firewall is first created its status is `enabled`. - * Use the [Update Firewall](/api/v4/networking-firewalls-firewall-id/#put) endpoint to set a Firewall's status to `enbaled` or `disabled`. - * Use the [Delete Firewall](/api/v4/networking-firewalls-firewall-id/#delete) endpoint to delete a Firewall. + * Use the [Update Firewall](/docs/api/networking/#update-firewall) endpoint to set a Firewall's status to `enbaled` or `disabled`. + * Use the [Delete Firewall](/docs/api/networking/#delete-firewall) endpoint to delete a Firewall. enum: - enabled - disabled @@ -16107,7 +16097,7 @@ components: The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses my be moved using the - [/networking/ipv4/assign](/api/v4/networking-ipv-4-assign/#post) + [/networking/ipv4/assign](/docs/api/networking/#assign-ips-to-linodes) endpoint. For SLAAC and link-local addresses, this value may not be changed. example: 123 readOnly: true @@ -16461,7 +16451,7 @@ components: readOnly: true description: > This is the location where the Linode was deployed. A Linode's region can only be changed by - initiating a [cross data center migration](/api/v4/linode-instances-linode-id-migrate/#post). + initiating a [cross data center migration](/docs/api/linode-instances/#initiate-dc-migrationpending-host-migration). x-linode-cli-display: 4 image: x-linode-filterable: true @@ -16473,11 +16463,11 @@ components: type: readOnly: true description: > - This is the [Linode Type](/api/v4/linode-types) that this + This is the [Linode Type](/docs/api/linode-types/#list-types) that this Linode was deployed with. To change a Linode's Type, use - [POST /linode/instances/{linodeId}/resize](/api/v4/linode-instances-linode-id-resize/#post). + [POST /linode/instances/{linodeId}/resize](/docs/api/linode-instances/#resize-linode). x-linode-cli-display: 5 group: deprecated: true @@ -16561,7 +16551,7 @@ components: description: | This Linode's IPv4 Addresses. Each Linode is assigned a single public IPv4 address upon creation, and may get a single private IPv4 address if needed. You may need to - [open a support ticket](/api/v4/support-tickets/#post) + [open a support ticket](/docs/api/support/#open-support-ticket) to get additional IPv4 addresses. IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. @@ -16587,10 +16577,10 @@ components: will divide this space between a primary disk with an `image` deployed to it, and a swap disk, usually 512 MB. This is the default configuration created when deploying a Linode with an `image` through - [POST /linode/instances](/api/v4/linode-instances/#post). + [POST /linode/instances](/docs/api/linode-instances/#create-linode). While this configuration is suitable for 99% of use cases, if you need finer control over your Linode's disks, see the - [/linode/instances/{linodeId}/disks](/api/v4/linode-instances-linode-id-disks) + [/linode/instances/{linodeId}/disks](/docs/api/linode-instances/#list-disks) endpoints. example: 81920 readOnly: true @@ -16600,7 +16590,7 @@ components: The amount of RAM, in MB, this Linode has access to. Typically a Linode will choose to boot with all of its available RAM, but this can be configured in a Config profile, see the - [/linode/instances/{linodeId}/configs](/api/v4/linode-instances-linode-id-configs) + [/linode/instances/{linodeId}/configs](/docs/api/linode-instances/#list-configuration-profiles) endpoints and the LinodeConfig object for more information. example: 4096 readOnly: true @@ -16611,7 +16601,7 @@ components: Typically a Linode will choose to boot with all of its available vcpus, but this can be configured in a Config Profile, see the - [/linode/instances/{linodeId}/configs](/api/v4/linode-instances-linode-id-configs) + [/linode/instances/{linodeId}/configs](/docs/api/linode-instances/#list-configuration-profiles) endpoints and the LinodeConfig object for more information. example: 2 readOnly: true @@ -16670,13 +16660,13 @@ components: type: object description: > Information about this Linode's backups status. For information about available - backups, see [/linode/instances/{linodeId}/backups](/api/v4/linode-instances-linode-id-backups). + backups, see [/linode/instances/{linodeId}/backups](/docs/api/linode-instances/#list-backups). properties: enabled: type: boolean description: > If this Linode has the Backup service enabled. To enable backups, see - [POST /linode/instances/{linodeId}/backups/enable](/api/v4/linode-instances-linode-id-backups-enable/#post). + [POST /linode/instances/{linodeId}/backups/enable](/docs/api/linode-instances/#enable-backups). example: true readOnly: true schedule: @@ -17045,8 +17035,8 @@ components: description: > Returns collection of Linode types, including pricing and specifications for each type. These are used when - [creating](/api/v4/linode-instances/#post) - or [resizing](/api/v4/linode-instances-linode-id-resize/#post) + [creating](/docs/api/linode-instances/#create-linode) + or [resizing](/docs/api/linode-instances/#resize-linode) Linodes. properties: id: @@ -17165,7 +17155,7 @@ components: readOnly: true nullable: true description: > - The Linode Type that a [mutate](/api/v4/linode-instances-linode-id-mutate/#post) + The Linode Type that a [mutate](/docs/api/linode-instances/#upgrade-linode) will upgrade to for a Linode of this type. If "null", a Linode of this type may not mutate. example: null @@ -17562,7 +17552,7 @@ components: The subscription ID for a particular Longview plan. A value of `null` corresponds to Longview Free. - You can send a request to the [List Longview Subscriptions](/api/v4/longview-subscriptions/) + You can send a request to the [List Longview Subscriptions](/docs/api/longview/#list-longview-subscriptions) endpoint to receive the details of each plan. example: longview-10 x-linode-cli-display: 1 @@ -18813,9 +18803,9 @@ components: Limited Access Keys can: - * [list all buckets](/api/v4/object-storage-buckets/) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket. + * [list all buckets](/docs/api/object-storage/#list-object-storage-buckets) available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket. - * [create new buckets](/api/v4/object-storage-buckets/#post), but do not have any access to the buckets it creates, unless explicitly given access to them. + * [create new buckets](/docs/api/object-storage/#create-object-storage-bucket), but do not have any access to the buckets it creates, unless explicitly given access to them. items: type: object properties: @@ -19121,7 +19111,7 @@ components: - disabled description: > The authentication methods that are allowed when connecting to - [the Linode Shell (Lish)](https://www.linode.com/docs/platform/manager/using-the-linode-shell-lish/). + [the Linode Shell (Lish)](/docs/platform/manager/using-the-linode-shell-lish/). * `keys_only` is the most secure if you intend to use Lish. @@ -19130,7 +19120,7 @@ components: * 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](/api/v4/profile) endpoint. + to the [View Profile](/docs/api/profile/#view-profile) endpoint. example: keys_only authorized_keys: type: array @@ -19146,7 +19136,7 @@ components: type: boolean description: > If true, logins from untrusted computers will require Two Factor - Authentication. See [/profile/tfa-enable](/api/v4/profile-tfa-enable/#post) to + Authentication. See [/profile/tfa-enable](/docs/api/profile/#create-two-factor-secret) to enable Two Factor Authentication. example: true x-linode-cli-display: 4 @@ -19155,7 +19145,7 @@ components: description: > If true, your User has restrictions on what can be accessed on your Account. To get details on what entities/actions you can - access/perform, see [/profile/grants](/api/v4/profile-grants). + access/perform, see [/profile/grants](/docs/api/profile/#list-grants). example: false x-linode-cli-display: 3 authentication_type: @@ -19360,7 +19350,7 @@ components: description: > This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See - Variables and UDFs + Variables and UDFs for more information. items: $ref: '#/components/schemas/UserDefinedField' @@ -19676,7 +19666,7 @@ components: * No ID attributes (i.e. `linode_id`, `domain_id`, etc.) should be provided with this request. - * Your account must have a [Managed service enabled](/api/v4/managed-services-service-id-enable/#post). + * Your account must have a [Managed service enabled](/docs/api/managed/#enable-managed-service). example: false volume_id: type: integer @@ -19754,7 +19744,7 @@ components: description: > If true, this User must be granted access to perform actions or access entities on this Account. See - [/account/users/{username}/grants](/api/v4/account-users-username-grants) + [/account/users/{username}/grants](/docs/api/account/#view-users-grants) for details on how to configure grants for a restricted User. example: true x-linode-cli-display: 3 @@ -19765,9 +19755,9 @@ components: description: > A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the `authorized_users` - field of a [create Linode](/api/v4/linode-instances/#post), - [rebuild Linode](/api/v4/linode-instances-linode-id-rebuild/#post), - or [create Disk](/api/v4/linode-instances-linode-id-disks/#post) request. + field of a [create Linode](/docs/api/linode-instances/#create-linode), + [rebuild Linode](/docs/api/linode-instances/#rebuild-linode), + or [create Disk](/docs/api/linode-instances/#create-disk) request. example: - home-pc - laptop @@ -19776,7 +19766,7 @@ components: readOnly: true description: > A boolean value indicating if the User has Two Factor Authentication (TFA) - enabled. See the Create Two Factor Secret ([/profile/tfa-enable](/api/v4/profile-tfa-enable/#post)) + enabled. See the Create Two Factor Secret ([/profile/tfa-enable](/docs/api/profile/#create-two-factor-secret)) endpoint to enable TFA. UserDefinedField: type: object @@ -19964,7 +19954,7 @@ components: * `resizing` - the Volume is in the process of upgrading its current capacity. * `contact_support` - there is a problem with your Volume. Please - [open a Support Ticket](/api/v4/support-tickets/#post) to resolve the issue. + [open a Support Ticket](/docs/api/support/#open-support-ticket) to resolve the issue. enum: - creating - active From 4ed8f0820771892839a0b147c151c6cf41387e41 Mon Sep 17 00:00:00 2001 From: leslitagordita Date: Wed, 16 Sep 2020 16:15:39 -0400 Subject: [PATCH 3/6] use markdown link and minor copy update --- openapi.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index f909238d6..45d9e2d58 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -6005,8 +6005,7 @@ paths: If the request is not authenticated, only public StackScripts are returned. - For more information on StackScripts, please read our guide: - Automate Deployment with StackScripts. + For more information on StackScripts, please read our [StackScripts guides](/docs/platform/stackscripts/). operationId: getStackScripts x-linode-cli-action: list security: From 382a91d2df4804fe3e8890571252bbb797c5ccf9 Mon Sep 17 00:00:00 2001 From: leslitagordita Date: Tue, 20 Oct 2020 13:06:50 -0400 Subject: [PATCH 4/6] Update a few outdated links --- openapi.yaml | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index c3cc4e983..3c8a10f1f 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -39,7 +39,7 @@ info: Linode Cloud Manager or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. - All scopes for the OAuth security model ([defined below](#o-auth)) apply to this + All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication @@ -50,7 +50,7 @@ info: ### OAuth If you only need to access the Linode API for personal use, - we recommend that you create a [personal access token](#personal-access-token). + we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. @@ -352,7 +352,7 @@ info: The Linode CLI allows you to easily work with the API using intuitive and simple syntax. It requires a - [Personal Access Token](#section/Personal-Access-Token) + [Personal Access Token](/docs/api/#personal-access-token) for authentication, and gives you access to all of the features and functionality of the Linode API that are documented here with CLI examples. @@ -3199,7 +3199,7 @@ paths: The cost for the Backup service is dependent on the Type of Linode deployed. This option is always treated as `true` if the account-wide `backups_enabled` - setting is `true`. See [account settings](#operaton/getAccountSettings) + setting is `true`. See [account settings](/docs/api/account/#account-settings-view) for more information. Backup pricing is included in the response from [/linodes/types](/docs/api/linode-types/#types-list) @@ -9157,7 +9157,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api//regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9218,7 +9218,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9367,7 +9367,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9422,7 +9422,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9491,7 +9491,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9544,7 +9544,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9609,7 +9609,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9687,7 +9687,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9741,7 +9741,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9789,7 +9789,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -9832,7 +9832,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/api/v4/regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of @@ -11776,7 +11776,7 @@ paths: Your TLS/SSL certificate and private key are stored encrypted at rest. - To replace an expired certificate, [delete your current certificate](/api/v4/object-storage-buckets-cluster-id-bucket-ssl/#delete) + To replace an expired certificate, [delete your current certificate](/docs/api/object-storage/#object-storage-tlsssl-cert-delete) and upload a new one. tags: - Object Storage @@ -16711,7 +16711,7 @@ components: to get additional IPv4 addresses. IPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. - See the [/networking](#tag/networking) endpoints for details. + See the [/networking](/docs/api/networking/) endpoints for details. x-linode-cli-display: 10 ipv6: type: string From 4d90a40692870587c27d69b0153f456a73abebb7 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 20 Oct 2020 13:16:21 -0400 Subject: [PATCH 5/6] removed extra / from link --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 3c8a10f1f..702715ad5 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9157,7 +9157,7 @@ paths: * Gain access to [Linode Cloud Firewall](https://www.linode.com/products/firewall/) by signing up for our [Greenlight Beta program](https://www.linode.com/green-light/#sign-up-form). - * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api//regions). + * During the beta, Cloud Firewall is only available in the [Sydney data center region](/docs/api/regions). * Please make sure to prepend all requests with `/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of From 4e46c913c611e94d2a4288cb59a01ebe3f66d17e Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 20 Oct 2020 13:27:47 -0400 Subject: [PATCH 6/6] Bump version to 4.78.3 --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index b75247485..a4cdcc7e5 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - version: 4.77.0 + version: 4.78.3 title: Linode API description: |