diff --git a/openapi.json b/openapi.json index 28e25d839..ee48bc1dd 100644 --- a/openapi.json +++ b/openapi.json @@ -613,7 +613,7 @@ "type": "string" }, "tax_id": { - "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> 📘\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", + "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> \ud83d\udcd8\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", "example": "ATU99999999", "maxLength": 25, "type": "string" @@ -1090,7 +1090,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> 📘\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -3981,7 +3981,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> 📘\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -6521,7 +6521,7 @@ }, "info": { "contact": { - "email": "jperez@linode.com", + "email": "support@linode.com", "name": "Linode", "url": "https://linode.com" }, @@ -6531,7 +6531,7 @@ "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Linode API", - "version": "4.197.0" + "version": "4.197.1" }, "openapi": "3.0.1", "paths": { @@ -6763,7 +6763,7 @@ "type": "string" }, "tax_id": { - "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> 📘\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", + "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> \ud83d\udcd8\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", "example": "ATU99999999", "maxLength": 25, "type": "string" @@ -6855,7 +6855,7 @@ "x-linode-grant": "read_only" }, "put": { - "description": "Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged.\n\n> 📘\n>\n> When updating an account's `country` to `US`, you'll get an error if the account's `zip` is not a valid US zip code.\n\n**Parent and child accounts**\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't change the `company` for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account.\n\n- Child account users can't run this operation. These users don't have access to billing-related operations.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account update \\\n --address_1 \"123 Main St.\" \\\n --address_2 \"Suite 101\" \\\n --city Philadelphia \\\n --company My Company \\ LLC \\\n --country US \\\n --email jsmith@mycompany.com \\\n --first_name John \\\n --last_name Smith \\\n --phone 555-555-1212 \\\n --state PA \\\n --tax_id ATU99999999 \\\n --zip 19102\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged.\n\n> \ud83d\udcd8\n>\n> When updating an account's `country` to `US`, you'll get an error if the account's `zip` is not a valid US zip code.\n\n**Parent and child accounts**\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't change the `company` for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account.\n\n- Child account users can't run this operation. These users don't have access to billing-related operations.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account update \\\n --address_1 \"123 Main St.\" \\\n --address_2 \"Suite 101\" \\\n --city Philadelphia \\\n --company My Company \\ LLC \\\n --country US \\\n --email jsmith@mycompany.com \\\n --first_name John \\\n --last_name Smith \\\n --phone 555-555-1212 \\\n --state PA \\\n --tax_id ATU99999999 \\\n --zip 19102\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-account" @@ -7080,7 +7080,7 @@ "type": "string" }, "tax_id": { - "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> 📘\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", + "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> \ud83d\udcd8\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", "example": "{{tax_id}}", "maxLength": 25, "type": "string" @@ -7324,7 +7324,7 @@ "type": "string" }, "tax_id": { - "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> 📘\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", + "description": "The tax identification number (TIN) assigned to this account, used for tax calculations. A TIN is set by the national authorities in your `country`, based on your `address_1`, and it may be named differently between countries. Set to an empty string (`\"\"`) if a TIN doesn't apply or for countries that don't collect tax.\n\n> \ud83d\udcd8\n>\n> This value is externally validated. If the validation is successful, a `tax_id_valid` [event](https://techdocs.akamai.com/linode-api/reference/get-events) is triggered. If unsuccessful, a `tax_id_invalid` event is triggered and an error response is issued for an operation that included it.", "example": "ATU99999999", "maxLength": 25, "type": "string" @@ -7709,7 +7709,7 @@ }, "/{apiVersion}/account/availability": { "get": { - "description": "Returns a paginated list of the services available to you, for all Linode regions.\n\n> 📘\n>\n> Only authorized users can run this operation.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account get-availability\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of the services available to you, for all Linode regions.\n\n> \ud83d\udcd8\n>\n> Only authorized users can run this operation.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account get-availability\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-availability" @@ -7946,7 +7946,7 @@ }, "/{apiVersion}/account/availability/{id}": { "get": { - "description": "View the available services for your account, in a specific region.\n\n> 📘\n>\n> Only account users with _unrestricted_ access can run this operation.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account get-account-availability us-east\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "View the available services for your account, in a specific region.\n\n> \ud83d\udcd8\n>\n> Only account users with _unrestricted_ access can run this operation.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account get-account-availability us-east\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-account-availability" @@ -8743,7 +8743,7 @@ }, "/{apiVersion}/account/cancel": { "post": { - "description": "Cancels an active account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails.\n\n> 📘\n>\n> Only account users with _unrestricted_ access can run this operation.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- A child account user can't cancel a child account.\n\n- You can't cancel a parent account if it has an active child account.\n\n- You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account cancel \\\n --comments \"I'm consolidating my accounts\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Cancels an active account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails.\n\n> \ud83d\udcd8\n>\n> Only account users with _unrestricted_ access can run this operation.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- A child account user can't cancel a child account.\n\n- You can't cancel a parent account if it has an active child account.\n\n- You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli account cancel \\\n --comments \"I'm consolidating my accounts\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-cancel-account" @@ -8932,7 +8932,7 @@ }, "/{apiVersion}/account/child-accounts": { "get": { - "description": "Returns a paginated list of basic information for the child accounts that exist for your parent account. See [Parent and Child Accounts for Akamai Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts.\n\n> 📘\n>\n> This operation can only be accessed by an unrestricted parent user, or restricted parent user with the `child_account_access` grant.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of basic information for the child accounts that exist for your parent account. See [Parent and Child Accounts for Akamai Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by an unrestricted parent user, or restricted parent user with the `child_account_access` grant.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-child-accounts" @@ -9164,7 +9164,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> 📘\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -9329,7 +9329,7 @@ }, "/{apiVersion}/account/child-accounts/{euuid}": { "get": { - "description": "View a specific child account based on its `euuid`. See [Parent and Child Accounts for Akamai Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts.\n\n> 📘\n>\n> This operation can only be accessed by an unrestricted user, or restricted user with the `child_account_access` grant.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "View a specific child account based on its `euuid`. See [Parent and Child Accounts for Akamai Partners](https://www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by an unrestricted user, or restricted user with the `child_account_access` grant.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-child-account" @@ -9523,7 +9523,7 @@ "x-linode-filterable": true }, "state": { - "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> 📘\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", + "description": "__Filterable__ The state or province for the billing address (`address_1` and `address_2, if applicable`). If in the United States (US) or Canada (CA), this is the two-letter ISO 3166 State or Province code.\n\n> \ud83d\udcd8\n>\n> If this is a US military address, use state abbreviations (AA, AE, AP).", "example": "CA", "maxLength": 24, "type": "string", @@ -9674,7 +9674,7 @@ }, "/{apiVersion}/account/child-accounts/{euuid}/token": { "post": { - "description": "Create a short-lived bearer token for a parent user on a child account, using the `euuid` of that child account. In the context of the API, a parent user on a child account is referred to as a \"proxy user.\" When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention:\n\n _\n\n> 📘\n>\n> These variables only use the first 15 and 16 characters of these values, respectively.\n\nThe token lets a parent account run API operations through the proxy user, as if they are a child user in the child account.\n\nThese points apply to the use of this operation:\n\n- To create a token, a parent account user needs the `child_account_access` grant. This lets them use the proxy user on the child account. You can run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) on a parent account user to check its `child_account_access` setting. To add this access, you can [update](https://techdocs.akamai.com/linode-api/reference/put-user-grants) the parent account user.\n\n- The created token inherits the permissions of the proxy user. It will never have less.\n\n- The API returns the raw token in the response. You can't get it again, so be sure to store it.\n\nExample workflow:\n\n1. [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) and store the `euuid` for the applicable one.\n2. Run this operation and store the `token` that's created for the proxy user.\n3. As a parent account user with access to the proxy user in the child account, use this `token` to authenticate API operations, as if you were a child user.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Create a short-lived bearer token for a parent user on a child account, using the `euuid` of that child account. In the context of the API, a parent user on a child account is referred to as a \"proxy user.\" When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention:\n\n _\n\n> \ud83d\udcd8\n>\n> These variables only use the first 15 and 16 characters of these values, respectively.\n\nThe token lets a parent account run API operations through the proxy user, as if they are a child user in the child account.\n\nThese points apply to the use of this operation:\n\n- To create a token, a parent account user needs the `child_account_access` grant. This lets them use the proxy user on the child account. You can run [List a user's grants](https://techdocs.akamai.com/linode-api/reference/get-user-grants) on a parent account user to check its `child_account_access` setting. To add this access, you can [update](https://techdocs.akamai.com/linode-api/reference/put-user-grants) the parent account user.\n\n- The created token inherits the permissions of the proxy user. It will never have less.\n\n- The API returns the raw token in the response. You can't get it again, so be sure to store it.\n\nExample workflow:\n\n1. [List child accounts](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) and store the `euuid` for the applicable one.\n2. Run this operation and store the `token` that's created for the proxy user.\n3. As a parent account user with access to the proxy user in the child account, use this `token` to authenticate API operations, as if you were a child user.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n child_account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-child-account-token" @@ -19279,7 +19279,7 @@ }, "/{apiVersion}/account/users": { "post": { - "description": "Creates a user on your account. You determine the new user's account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user's `email` address.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- A parent account user can create new parent account users.\n\n- A child account can [update](https://techdocs.akamai.com/linode-api/reference/put-user) the child account parent user (proxy user) to `unrestricted`. This gives the proxy user access to create new child account users.\n\n- A child account user can create new child account users.\n\n- You can't create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users create \\\n --username example_user \\\n --email example_user@linode.com \\\n --restricted true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates a user on your account. You determine the new user's account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user's `email` address.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- A parent account user can create new parent account users.\n\n- A child account can [update](https://techdocs.akamai.com/linode-api/reference/put-user) the child account parent user (proxy user) to `unrestricted`. This gives the proxy user access to create new child account users.\n\n- A child account user can create new child account users.\n\n- You can't create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users create \\\n --username example_user \\\n --email example_user@linode.com \\\n --restricted true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-user" @@ -19582,7 +19582,7 @@ "x-linode-grant": "unrestricted only" }, "get": { - "description": "Returns a paginated list of all users on your account.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\nA user can access all or part of an account based on their access status and grants:\n\n- __Unrestricted access__. These users can access everything on an account.\n\n- __Restricted access__. These users can only access entities or perform actions they've been given specific grants to.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of all users on your account.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\nA user can access all or part of an account based on their access status and grants:\n\n- __Unrestricted access__. These users can access everything on an account.\n\n- __Restricted access__. These users can only access entities or perform actions they've been given specific grants to.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-users" @@ -19906,7 +19906,7 @@ }, "/{apiVersion}/account/users/{username}": { "get": { - "description": "Returns information about a single user on your account.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users view example_user\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns information about a single user on your account.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users view example_user\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-user" @@ -19916,6 +19916,9 @@ "200": { "content": { "application/json": { + "example": { + "ref": "../examples/get-user-200.json" + }, "schema": { "allOf": [ { @@ -20042,9 +20045,6 @@ "x-akamai": { "file-path": "schemas/added-get-user-200.yaml" } - }, - "x-example": { - "x-ref": "../examples/get-user-200.json" } } }, @@ -20119,7 +20119,7 @@ "x-linode-grant": "unrestricted only" }, "put": { - "description": "Update information about a user on your account, including its restricted status. When setting a user to `restricted`, the API sets no grants for it. You need to set grants so that user can access things on the account.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't edit the `username` or `email` values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user's `restricted` status can be modified. This can only be done by an unrestricted child account user.\n\n- A parent account using an unrestricted proxy user in a child account can modify the `username`, `email`, and `restricted` status for an existing child account user.\n\n- A restricted account user--parent or child--can't change their user to `unrestricted`.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users update example_user \\\n --username example_user \\\n --email example@linode.com \\\n --restricted true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Update information about a user on your account, including its restricted status. When setting a user to `restricted`, the API sets no grants for it. You need to set grants so that user can access things on the account.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't edit the `username` or `email` values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user's `restricted` status can be modified. This can only be done by an unrestricted child account user.\n\n- A parent account using an unrestricted proxy user in a child account can modify the `username`, `email`, and `restricted` status for an existing child account user.\n\n- A restricted account user--parent or child--can't change their user to `unrestricted`.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users update example_user \\\n --username example_user \\\n --email example@linode.com \\\n --restricted true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-user" @@ -20454,7 +20454,7 @@ "x-linode-grant": "unrestricted only" }, "delete": { - "description": "Deletes a user. The API immediately logs the user out and removes all of its `grants`.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation.\n\n- A parent account using an unrestricted proxy user can use this operation to delete a child account user.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users delete example_user\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Deletes a user. The API immediately logs the user out and removes all of its `grants`.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- You can't delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation.\n\n- A parent account using an unrestricted proxy user can use this operation to delete a child account user.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli users delete example_user\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-user" @@ -20590,7 +20590,7 @@ }, "/{apiVersion}/account/users/{username}/grants": { "get": { - "description": "Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them.\n\nThis doesn't apply to the account owner or the current authenticated user. You can run the [List grants](https://techdocs.akamai.com/linode-api/reference/get-profile-grants) operation to view those grants. However, this doesn't show the entities that they _don't_ have access to.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them.\n\nThis doesn't apply to the account owner or the current authenticated user. You can run the [List grants](https://techdocs.akamai.com/linode-api/reference/get-profile-grants) operation to view those grants. However, this doesn't show the entities that they _don't_ have access to.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-user-grants" @@ -21119,7 +21119,7 @@ "x-linode-grant": "unrestricted only" }, "put": { - "description": "Update the grants a user has. This can be used to give a user access to new entities or actions, or take access away. You don't need to include the grant for every entity on the account in this request. Any that are not included remain unchanged.\n\n> 📘\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- No child account user can modify the `account_access` grant for the child account parent user (proxy user).\n\n- An unrestricted child account user can configure all other grants for the proxy user, via `global` object.\n\n- An unrestricted child account user can enable the `account_access` grant for other child account users. However, enabled child users are still subject to child user restrictions--they can't perform write operations for any billing or account information.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Update the grants a user has. This can be used to give a user access to new entities or actions, or take access away. You don't need to include the grant for every entity on the account in this request. Any that are not included remain unchanged.\n\n> \ud83d\udcd8\n>\n> This operation can only be accessed by account users with _unrestricted_ access.\n\n__Parent and child accounts__\n\nIn a [parent and child account](https://www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply:\n\n- No child account user can modify the `account_access` grant for the child account parent user (proxy user).\n\n- An unrestricted child account user can configure all other grants for the proxy user, via `global` object.\n\n- An unrestricted child account user can enable the `account_access` grant for other child account users. However, enabled child users are still subject to child user restrictions--they can't perform write operations for any billing or account information.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-user-grants" @@ -23176,8 +23176,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.6/24", - "192.0.2.248/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -23258,7 +23258,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-123-456-mysql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -23608,7 +23608,7 @@ }, "/{apiVersion}/databases/mysql/instances": { "post": { - "description": "**Provision a MySQL Managed Database**\n\nUse this operation to create a new MySQL Managed Database.\n\n- Restricted users need the `add_databases` [user grant](https://techdocs.akamai.com/linode-api/reference/get-user-grants).\n\n- New instances can take 10 to 15 minutes to deploy.\n\n- All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\n- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the MySQL Managed Database. Configure the maintenance window for these updates with the [Update a managed MySQL database](https://techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation.\n\n- If your database cluster is configured with a single node, downtime occurs during maintenance updates. You should adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/managed-databases#high-availability) plan to avoid any maintenance downtime.\n\n- Major upgrades are optional until the service reaches end of service, and can be done in place.\n\n**Restore a MySQL Managed Database**\n\nDo this by creating a `fork` from a backup. A user needs `read_write` access to the database and its status can be `active`, `degraded`, or `failed`.\n\n> 📘\n>\n> Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.\n\n\n<>\n\n---\n\n\n- __CLI for create operation__.\n\n ```\n linode-cli databases mysql-create \\\n --label example-db1 \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine mysql/8.0.26 \\\n --ssl_connection true \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n databases:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "**Provision a MySQL Managed Database**\n\nUse this operation to create a new MySQL Managed Database.\n\n- Restricted users need the `add_databases` [user grant](https://techdocs.akamai.com/linode-api/reference/get-user-grants).\n\n- New instances can take 10 to 15 minutes to deploy.\n\n- All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\n- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the MySQL Managed Database. Configure the maintenance window for these updates with the [Update a managed MySQL database](https://techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation.\n\n- If your database cluster is configured with a single node, downtime occurs during maintenance updates. You should adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/managed-databases#high-availability) plan to avoid any maintenance downtime.\n\n- Major upgrades are optional until the service reaches end of service, and can be done in place.\n\n**Restore a MySQL Managed Database**\n\nDo this by creating a `fork` from a backup. A user needs `read_write` access to the database and its status can be `active`, `degraded`, or `failed`.\n\n> \ud83d\udcd8\n>\n> Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.\n\n\n<>\n\n---\n\n\n- __CLI for create operation__.\n\n ```\n linode-cli databases mysql-create \\\n --label example-db1 \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine mysql/8.0.26 \\\n --ssl_connection true \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n databases:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-databases-mysql-instances" @@ -23624,8 +23624,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.73/24", - "192.0.2.129/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -23762,8 +23762,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.160/24", - "192.0.2.115/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -23840,7 +23840,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-123-456-mysql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -24287,8 +24287,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.193/24", - "192.0.2.140/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -24365,7 +24365,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-123-456-mysql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -24728,8 +24728,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.158/24", - "192.0.2.165/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -24806,7 +24806,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-123-456-mysql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -25135,8 +25135,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.254/24", - "192.0.2.127/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -25268,8 +25268,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.186/24", - "192.0.2.205/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -25346,7 +25346,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-123-456-mysql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -26610,7 +26610,7 @@ }, "/{apiVersion}/databases/postgresql/instances": { "post": { - "description": "**Provision a PostgreSQL Managed Database**\n\nUse this operation to create a new PostgreSQL Managed Database.\n\n- Restricted users need the `add_databases` [user grant](https://techdocs.akamai.com/linode-api/reference/get-user-grants).\n\n- New instances can take 10 to 15 minutes to deploy.\n\n- All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\n- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the PostgreSQL Managed Database. Configure the maintenance window for these updates with the [Update a managed PostgreSQL database](https://techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation.\n\n- If your database cluster is configured with a single node, downtime occurs during maintenance updates. Adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/managed-databases#high-availability) plan to avoid any maintenance downtime.\n\n- Major upgrades are optional until the service reaches end of service, and can be done in place.\n\n**Restore a PostgreSQL Managed Database**\n\nDo this by creating a `fork` from a backup. A user needs `read_write` access to the database, and its status can be `active`, `degraded`, or `failed`.\n\n> 📘\n>\n> Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli databases postgresql-create \\\n --label example-db \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine postgresql/13.2 \\\n --ssl_connection true \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n databases:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "**Provision a PostgreSQL Managed Database**\n\nUse this operation to create a new PostgreSQL Managed Database.\n\n- Restricted users need the `add_databases` [user grant](https://techdocs.akamai.com/linode-api/reference/get-user-grants).\n\n- New instances can take 10 to 15 minutes to deploy.\n\n- All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.\n\n- All Managed Databases include automatic updates, which apply security patches to the underlying operating system of the PostgreSQL Managed Database. Configure the maintenance window for these updates with the [Update a managed PostgreSQL database](https://techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation.\n\n- If your database cluster is configured with a single node, downtime occurs during maintenance updates. Adjust the window to match a time that's the least disruptive to your application and users. Also consider upgrading to a [high availability](https://techdocs.akamai.com/cloud-computing/docs/managed-databases#high-availability) plan to avoid any maintenance downtime.\n\n- Major upgrades are optional until the service reaches end of service, and can be done in place.\n\n**Restore a PostgreSQL Managed Database**\n\nDo this by creating a `fork` from a backup. A user needs `read_write` access to the database, and its status can be `active`, `degraded`, or `failed`.\n\n> \ud83d\udcd8\n>\n> Restoring from a backup creates a second running cluster, which incurs billing. Delete the first cluster after the restore is complete, to avoid this billing.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli databases postgresql-create \\\n --label example-db \\\n --region us-east \\\n --type g6-dedicated-2 \\\n --cluster_size 3 \\\n --engine postgresql/13.2 \\\n --ssl_connection true \\\n --allow_list 203.0.113.1 \\\n --allow_list 192.0.1.0/24\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n databases:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instances" @@ -26626,8 +26626,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.58/24", - "192.0.2.24/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -26764,8 +26764,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.46/24", - "192.0.2.1/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -26842,7 +26842,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly viewable and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly viewable and accessible.", "example": "lin-0000-000-pgsql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -27282,8 +27282,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.241/24", - "192.0.2.171/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -27360,7 +27360,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-0000-000-pgsql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -27723,8 +27723,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.51/24", - "192.0.2.121/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -27801,7 +27801,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-0000-000-pgsql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -28130,8 +28130,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.54/24", - "192.0.2.112/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -28263,8 +28263,8 @@ "allow_list": { "description": "Controls access to the Managed Database.\n\n- Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.\n\n- A standalone value of `0.0.0.0/0` allows all IP addresses access to the Managed Database.\n\n- An empty array (`[]`) blocks all public and private connections to the Managed Database.", "example": [ - "192.0.2.72/24", - "192.0.2.237/24" + "203.0.113.1/32", + "192.0.1.0/24" ], "items": { "format": "ipv4/prefix_length", @@ -28341,7 +28341,7 @@ "type": "string" }, "secondary": { - "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> 📘\n>\n> The secondary hostname is publicly visible and accessible.", + "description": "The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.\n\n> \ud83d\udcd8\n>\n> The secondary hostname is publicly visible and accessible.", "example": "lin-0000-000-pgsql-primary-private.servers.linodedb.net", "nullable": true, "type": "string" @@ -30316,7 +30316,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -30486,7 +30486,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -30759,7 +30759,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -31082,7 +31082,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -31344,7 +31344,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -31578,7 +31578,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -31739,7 +31739,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -32147,7 +32147,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -33937,7 +33937,7 @@ }, "/{apiVersion}/images": { "post": { - "description": "Captures a private, gold-master image from a Linode disk.\n\n> 📘\n>\n> - Captured images are stored using our Object Storage service. The `region` where the target image exists determines where the [resulting image is stored](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-captured-custom-images).\n>\n> - If you create an image from an encrypted disk, the API doesn't encrypt the image. When you rebuild a compute instance from that image, the resulting disk will be automatically encrypted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images create \\\n --label this_is_a_label \\\n --description \"A longer description \\\n of the image\" \\\n --disk_id 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\nlinodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Captures a private, gold-master image from a Linode disk.\n\n> \ud83d\udcd8\n>\n> - Captured images are stored using our Object Storage service. The `region` where the target image exists determines where the [resulting image is stored](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-captured-custom-images).\n>\n> - If you create an image from an encrypted disk, the API doesn't encrypt the image. When you rebuild a compute instance from that image, the resulting disk will be automatically encrypted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images create \\\n --label this_is_a_label \\\n --description \"A longer description \\\n of the image\" \\\n --disk_id 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\nlinodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-image" @@ -34150,7 +34150,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -34190,7 +34190,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -34515,7 +34515,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -34555,7 +34555,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -34739,7 +34739,7 @@ }, "/{apiVersion}/images/upload": { "post": { - "description": "Creates a new private image container and returns a URL as the `upload_to` object in the response. Use this URL to upload your own disk image to the container.\n\n1. Ensure the disk image is raw disk image (`.img`) format.\n\n2. Compress the disk image using gzip (`.gz`) format. Compressed, the file can be up to 5 GB and decompressed it can be up to 6 GB.\n\n3. Upload the file in a separate PUT request that includes the `Content-type: application/octet-stream` header:\n\n ```\n curl -v \\\n -H \"Content-Type: application/octet-stream\" \\\n --upload-file example.img.gz \\\n $UPLOAD_URL \\\n --progress-bar \\\n --output /dev/null\n ```\n\n> 📘\n>\n> - You need to upload image data within 24 hours of creation or the API cancels the upload and deletes the image container.\n>\n> - Only core regions that support our [Object Storage](https://techdocs.akamai.com/cloud-computing/reference/how-to-choose-a-data-center#product-availability) service can store an uploaded image.\n>\n> - If you create an image from an encrypted disk, the API doesn't encrypt the image. When you rebuild a compute instance from that image, the resulting disk will be automatically encrypted.\n>\n> - You can create a new image and upload image data using a single process through [Cloud Manager](https://www.linode.com/docs/products/tools/images/guides/upload-an-image/#uploading-an-image-file-through-the-cloud-manager) or the [Linode CLI](https://www.linode.com/docs/products/tools/images/guides/upload-an-image/#uploading-an-image-file-through-the-linode-cli).\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n # Run the operation to just get the upload_to URL\nlinode-cli images upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east\n\n# Upload the image file in a single step\nlinode-cli image-upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east \\\n /path/to/image-file.img.gz\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates a new private image container and returns a URL as the `upload_to` object in the response. Use this URL to upload your own disk image to the container.\n\n1. Ensure the disk image is raw disk image (`.img`) format.\n\n2. Compress the disk image using gzip (`.gz`) format. Compressed, the file can be up to 5 GB and decompressed it can be up to 6 GB.\n\n3. Upload the file in a separate PUT request that includes the `Content-type: application/octet-stream` header:\n\n ```\n curl -v \\\n -H \"Content-Type: application/octet-stream\" \\\n --upload-file example.img.gz \\\n $UPLOAD_URL \\\n --progress-bar \\\n --output /dev/null\n ```\n\n> \ud83d\udcd8\n>\n> - You need to upload image data within 24 hours of creation or the API cancels the upload and deletes the image container.\n>\n> - Only core regions that support our [Object Storage](https://techdocs.akamai.com/cloud-computing/reference/how-to-choose-a-data-center#product-availability) service can store an uploaded image.\n>\n> - If you create an image from an encrypted disk, the API doesn't encrypt the image. When you rebuild a compute instance from that image, the resulting disk will be automatically encrypted.\n>\n> - You can create a new image and upload image data using a single process through [Cloud Manager](https://www.linode.com/docs/products/tools/images/guides/upload-an-image/#uploading-an-image-file-through-the-cloud-manager) or the [Linode CLI](https://www.linode.com/docs/products/tools/images/guides/upload-an-image/#uploading-an-image-file-through-the-linode-cli).\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n # Run the operation to just get the upload_to URL\nlinode-cli images upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east\n\n# Upload the image file in a single step\nlinode-cli image-upload \\\n --description \"Optional details about the Image\" \\\n --label \"Example Image\" \\\n --region us-east \\\n /path/to/image-file.img.gz\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-upload-image" @@ -34960,7 +34960,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -35000,7 +35000,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -35331,7 +35331,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -35371,7 +35371,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -35502,7 +35502,7 @@ "x-linode-cli-action": "view" }, "put": { - "description": "Updates a private image that you have permission to `read_write`.\n\n> 📘\n>\n> You can't update the `regions` with this operation. Use the [Replicate an image](https://techdocs.akamai.com/linode-api/reference/post-replicate-image) operation to modify the existing regions for your image.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images update private/12345 \\\n --label \"My gold-master image\" \\\n --description \"The detailed description \\\n of my image.\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Updates a private image that you have permission to `read_write`.\n\n> \ud83d\udcd8\n>\n> You can't update the `regions` with this operation. Use the [Replicate an image](https://techdocs.akamai.com/linode-api/reference/post-replicate-image) operation to modify the existing regions for your image.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images update private/12345 \\\n --label \"My gold-master image\" \\\n --description \"The detailed description \\\n of my image.\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-image" @@ -35658,7 +35658,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -35698,7 +35698,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": "{{total_size}}", "readOnly": true, "type": "integer", @@ -35909,7 +35909,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -35949,7 +35949,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -36081,7 +36081,7 @@ "x-linode-grant": "read_write" }, "delete": { - "description": "Deletes a private image you have permission to `read_write`.\n\n> 🚧\n>\n> - You can't undo this delete action.\n>\n> - When you delete an image, all [replicated instances](https://techdocs.akamai.com/linode-api/reference/post-replicate-image) of that image are also deleted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Deletes a private image you have permission to `read_write`.\n\n> \ud83d\udea7\n>\n> - You can't undo this delete action.\n>\n> - When you delete an image, all [replicated instances](https://techdocs.akamai.com/linode-api/reference/post-replicate-image) of that image are also deleted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli images delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n images:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-image" @@ -36406,7 +36406,7 @@ "x-linode-filterable": true }, "status": { - "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> 📘\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", + "description": "__Filterable__, __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`.\n\n> \ud83d\udcd8\n>\n> The `+order_by` and `+order` operators are not available when [filtering](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) on this key.", "enum": [ "creating", "pending_upload", @@ -36446,7 +36446,7 @@ "x-linode-filterable": true }, "total_size": { - "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> 📘\n>\n> This object is empty for existing images. It's intended for use with future functionality.", + "description": "__Read-only__ The total size in bytes of all instances of this image, in all `regions`.\n\n> \ud83d\udcd8\n>\n> This object is empty for existing images. It's intended for use with future functionality.", "example": 1234567, "readOnly": true, "type": "integer", @@ -36747,7 +36747,7 @@ "x-linode-filterable": true }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -36764,7 +36764,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.12" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -36776,8 +36776,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.121", - "vpc": "192.0.2.241" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -36804,10 +36804,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.90/24", - "2001:db8:e4a6:4266:5d21:d95f:1810:2794/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -36844,14 +36844,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.166", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.203", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -36876,7 +36876,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -37224,7 +37224,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.63", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -37243,7 +37243,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:7c77:ade7:fe1a:f375:7321:fa32/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -37297,7 +37297,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -37307,7 +37307,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -37878,7 +37878,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.242", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -37897,7 +37897,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:8363:97bc:552d:ef40:f31e:de7f/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -37957,7 +37957,7 @@ "type": "string" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -37967,7 +37967,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -38460,7 +38460,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.134", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -38479,7 +38479,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:37be:62dc:8cad:d837:5502:8cb5/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -38539,7 +38539,7 @@ "type": "string" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -38549,7 +38549,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -38829,7 +38829,7 @@ "x-linode-grant": "read_only" }, "put": { - "description": "Updates a Linode that you have permission to `read_write`. Only unrestricted users can add or modify tags on Linodes.\n<>\n\n> 🚧\n>\n> All tags for the instance are overwritten if `tags` are included in the request.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes update 7833080 \\\n --label linode123 \\\n --backups.schedule.day \"Saturday\" \\\n --backups.schedule.window \"W22\" \\\n --alerts.cpu 180 \\\n --alerts.network_in 10 \\\n --alerts.network_out 10 \\\n --alerts.transfer_quota 80 \\\n --alerts.io 10000\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Updates a Linode that you have permission to `read_write`. Only unrestricted users can add or modify tags on Linodes.\n<>\n\n> \ud83d\udea7\n>\n> All tags for the instance are overwritten if `tags` are included in the request.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes update 7833080 \\\n --label linode123 \\\n --backups.schedule.day \"Saturday\" \\\n --backups.schedule.window \"W22\" \\\n --alerts.cpu 180 \\\n --alerts.network_in 10 \\\n --alerts.network_out 10 \\\n --alerts.transfer_quota 80 \\\n --alerts.io 10000\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-linode-instance" @@ -39044,7 +39044,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.138", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -39117,7 +39117,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -39127,7 +39127,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -39487,7 +39487,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.230", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -39506,7 +39506,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:cc7e:b838:b680:d4b3:aa62:c74c/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -39560,7 +39560,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -39570,7 +39570,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -39925,7 +39925,7 @@ }, "/{apiVersion}/linode/instances/{linodeId}/backups": { "post": { - "description": "Creates a snapshot backup of a Linode.\n\n> 📘\n>\n> - Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n>\n> - If you already have a snapshot of this Linode, the previous snapshot will be deleted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes snapshot 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates a snapshot backup of a Linode.\n\n> \ud83d\udcd8\n>\n> - Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n>\n> - If you already have a snapshot of this Linode, the previous snapshot will be deleted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes snapshot 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-snapshot" @@ -39997,7 +39997,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -40216,7 +40216,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -40358,7 +40358,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -40485,7 +40485,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -40629,7 +40629,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -40970,7 +40970,7 @@ }, "/{apiVersion}/linode/instances/{linodeId}/backups/enable": { "post": { - "description": "Enables backups for the specified Linode.\n\n> 📘\n>\n> Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes backups-enable 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Enables backups for the specified Linode.\n\n> \ud83d\udcd8\n>\n> Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes backups-enable 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-enable-backups" @@ -41147,7 +41147,7 @@ "additionalProperties": false, "properties": { "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -41371,7 +41371,7 @@ }, "/{apiVersion}/linode/instances/{linodeId}/backups/{backupId}/restore": { "post": { - "description": "Restores a Linode's backup to the specified Linode.\n\n- Backups may not be restored across regions.\n- Only successfully completed backups that are not undergoing maintenance can be restored.\n- The Linode that the backup is being restored to can't be the target of a current backup.\n\nWhen you restore a backup, the restored disk is assigned the same [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) as the original disk. In most cases, this is acceptable and doesn't cause issues. However, if you try to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile's __Block Device Assignment__), you'll encounter a UUID \"collision\".\n\nWhen this happens, the system selects, and mounts, only one of the disks at random. This is because both disks are sharing the same UUID. Your instance _may fail to boot_ because the API can't tell which disk is root. If your system boots in this scenario, you won't see an immediate indication if you're booted into the restored disk or the original disk, and you'll be unable to access both disks at the same time.\n\nTo avoid this, only restore a backup to the same Linode if you don't intend to mount them at the same time, or you're comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously -- for example, if you need to copy files between them -- you should restore the backup to a separate Linode or [create](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) a new Linode using the desired `backup_id`.\n\nTo learn more about block device assignments and viewing your disks' UUIDs, see our guide on [Configuration Profiles](https://www.linode.com/docs/products/compute/compute-instances/guides/configuration-profiles/#block-device-assignment).\n\n> 📘\n>\n> Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes backup-restore 123 123456 \\\n --linode_id 234 \\\n --overwrite true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Restores a Linode's backup to the specified Linode.\n\n- Backups may not be restored across regions.\n- Only successfully completed backups that are not undergoing maintenance can be restored.\n- The Linode that the backup is being restored to can't be the target of a current backup.\n\nWhen you restore a backup, the restored disk is assigned the same [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) as the original disk. In most cases, this is acceptable and doesn't cause issues. However, if you try to mount both the original disk and the corresponding restore disk at the same time (by assigning them both to devices in your Configuration Profile's __Block Device Assignment__), you'll encounter a UUID \"collision\".\n\nWhen this happens, the system selects, and mounts, only one of the disks at random. This is because both disks are sharing the same UUID. Your instance _may fail to boot_ because the API can't tell which disk is root. If your system boots in this scenario, you won't see an immediate indication if you're booted into the restored disk or the original disk, and you'll be unable to access both disks at the same time.\n\nTo avoid this, only restore a backup to the same Linode if you don't intend to mount them at the same time, or you're comfortable modifying UUIDs. If you need access to files on both the original disk and the restored disk simultaneously -- for example, if you need to copy files between them -- you should restore the backup to a separate Linode or [create](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) a new Linode using the desired `backup_id`.\n\nTo learn more about block device assignments and viewing your disks' UUIDs, see our guide on [Configuration Profiles](https://www.linode.com/docs/products/compute/compute-instances/guides/configuration-profiles/#block-device-assignment).\n\n> \ud83d\udcd8\n>\n> Backups aren't encrypted even when they're taken from an encrypted disk. When a backup is restored, and if encryption is enabled, the data stored on the disk is encrypted again.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes backup-restore 123 123456 \\\n --linode_id 234 \\\n --overwrite true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-restore-backup" @@ -42037,7 +42037,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.215", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -42056,7 +42056,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:5695:701:c985:f8eb:329f:5e98/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -42110,7 +42110,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -42120,7 +42120,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -42618,7 +42618,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -42635,7 +42635,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.203" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -42647,8 +42647,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.147", - "vpc": "192.0.2.244" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -42675,10 +42675,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.236/24", - "2001:db8:c9cb:43ef:eb48:2a94:ddc0:7732/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -42715,14 +42715,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.208", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.36", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -42747,7 +42747,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -42819,7 +42819,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "/dev/sda", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -43098,7 +43098,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -43115,7 +43115,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.119" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -43127,8 +43127,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.63", - "vpc": "192.0.2.166" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -43155,10 +43155,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.184/24", - "2001:db8:2144:19ef:cc8:6daa:d86c:80f8/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -43195,14 +43195,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.39", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.213", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -43227,7 +43227,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -43299,7 +43299,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "/dev/sda", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -43680,7 +43680,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -43697,7 +43697,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.110" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -43709,8 +43709,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.73", - "vpc": "192.0.2.185" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -43737,10 +43737,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.248/24", - "2001:db8:e1bf:5720:d4a3:3e21:f4da:aefc/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -43777,14 +43777,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.166", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.124", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -43809,7 +43809,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -43881,7 +43881,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "/dev/sda", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -44254,7 +44254,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -44271,7 +44271,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.224" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -44283,8 +44283,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.242", - "vpc": "192.0.2.32" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -44311,10 +44311,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.201/24", - "2001:db8:c2a3:eb66:479:dcea:ac7f:2ee1/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -44351,14 +44351,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.31", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.156", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -44383,7 +44383,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -44455,7 +44455,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "/dev/sda", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -44798,7 +44798,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -44815,7 +44815,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.195" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -44827,8 +44827,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.214", - "vpc": "192.0.2.175" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -44855,10 +44855,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.76/24", - "2001:db8:3172:839:ba2c:f95e:d66b:3da6/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -44895,14 +44895,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.144", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.93", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -44927,7 +44927,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -44999,7 +44999,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "{{root_device}}", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -45268,7 +45268,7 @@ "x-linode-cli-display": 1 }, "interfaces": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -45285,7 +45285,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.146" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -45297,8 +45297,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.183", - "vpc": "192.0.2.113" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -45325,10 +45325,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.161/24", - "2001:db8:240:1b07:f8f2:5760:9f6:a632/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -45365,14 +45365,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.106", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.125", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -45397,7 +45397,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -45469,7 +45469,7 @@ "type": "integer" }, "root_device": { - "description": "The root device to boot.\n\n> 📘\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", + "description": "The root device to boot.\n\n> \ud83d\udcd8\n\n- If you leave this empty or set an invalid value, the root device defaults to `/dev/sda`.\n\n- If you specify a device at the root device location and it's not mounted, the Linode won't boot until a device is mounted.", "example": "/dev/sda", "pattern": "a-z, A-Z, 0-9, /, _, -", "type": "string" @@ -45757,10 +45757,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.213/24", - "2001:db8:2d62:563:6bd0:763d:2607:2fad/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -45797,14 +45797,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.22", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.208", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -45829,7 +45829,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -45900,10 +45900,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.97/24", - "2001:db8:a94:5b6c:6f30:14d7:3c6d:512c/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -45940,14 +45940,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.233", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.227", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -45972,7 +45972,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -46101,7 +46101,7 @@ "content": { "application/json": { "schema": { - "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> 📘\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", + "description": "An array of Network interfaces to add to this Linode's Configuration Profile. At least one and up to three Interface objects can exist in this array. The position in the array determines which of the Linode's network interfaces is configured:\n\n- First [0]: eth0\n- Second [1]: eth1\n- Third [2]: eth2\n\nWhen updating a Linode's interfaces, _each Interface must be redefined_. An empty `interfaces` array results in a default `public` type Interface configuration only.\n\nIf no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration.\n\n> \ud83d\udcd8\n>\n> Changes to Linode Interface configurations can be enabled by rebooting the Linode.\n\n`vpc` details\n\nSee the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations.\n\n`vlan` details\n\n- Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated or cloned because of an incompatibility, you will be prompted to select a different data center or contact support.\n- See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.", "example": [ { "id": 101, @@ -46118,7 +46118,7 @@ "ipam_address": "10.0.0.1/24", "ipv4": { "nat_1_1": null, - "vpc": "192.0.2.83" + "vpc": "10.0.0.2" }, "label": "vlan-1", "primary": false, @@ -46130,8 +46130,8 @@ "id": 103, "ipam_address": null, "ipv4": { - "nat_1_1": "192.0.2.91", - "vpc": "192.0.2.208" + "nat_1_1": "203.0.113.2", + "vpc": "10.0.1.2" }, "label": null, "primary": true, @@ -46158,10 +46158,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.10/24", - "2001:db8:55c1:4688:150:bd5:7e2d:7a77/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -46198,14 +46198,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.182", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.228", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -46230,7 +46230,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -46629,10 +46629,10 @@ "x-linode-cli-display": 1 }, "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> 📘\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\nWhen included in a request:\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Submit this as an empty array removes all existing values.\n\n- Omit this object to leave existing values as is.\n\n<>\n\n> \ud83d\udcd8\n>\n> This is only supported for interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.79/24", - "2001:db8:2fa4:b21d:a1a7:a0ff:decd:b44/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -46669,14 +46669,14 @@ "type": "string" } ], - "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> 📘\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", - "example": "192.0.2.134", + "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- Only supported for interfaces with a `purpose` of `vpc`.\n\n- Returned as `null` if no 1:1 NAT is set for a `vpc` type interface.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be shared with another Linode.\n\n- Omit this object or include it and set it to `null` or an empty string (`\"\"`) to block creation of a 1:1 NAT.\n\n<>\n\n> \ud83d\udcd8\n>\n> You can't set this to a specific IPv4 address when creating a new Linode. During the creation process, the network automatically establishes a public IPv4 address for the Linode. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. After your Linode is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- This only applies to interfaces with a `purpose` of `vpc`.\n\n- Returned as an empty string (`\"\"`) for non-`vpc` type interfaces.\n\nWhen included in a request:\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the Subnet IPv4 range is automatically assigned.", - "example": "192.0.2.191", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -46701,7 +46701,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> 📘\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. If you haven't specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.\n\n> \ud83d\udcd8\n>\n> This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -46835,10 +46835,10 @@ "description": "Linode configuration profile interface update request object.", "properties": { "ip_ranges": { - "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Include this as an empty array (`[]`) to remove all existing `nat_1_1` values.\n\n- Omit this array to leave all existing `ip_ranges` as is.\n<>\n> 📘\n>\n> This only applies to interfaces with a `purpose` of `vpc`.", + "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface.\n\n- A range can't include any addresses that are assigned to an active Linode or another VPC subnet.\n\n- When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed.\n\n- Include this as an empty array (`[]`) to remove all existing `nat_1_1` values.\n\n- Omit this array to leave all existing `ip_ranges` as is.\n<>\n> \ud83d\udcd8\n>\n> This only applies to interfaces with a `purpose` of `vpc`.", "example": [ - "192.0.2.241/24", - "2001:db8:b2d8:2cf7:ab0b:bc06:fb20:7f39/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -46848,7 +46848,7 @@ }, "ipv4": { "additionalProperties": false, - "description": "IPv4 addresses configured for this interface.\n\n> 📘\n>\n> This only applies to interfaces with a `purpose` of `vpc`.", + "description": "IPv4 addresses configured for this interface.\n\n> \ud83d\udcd8\n>\n> This only applies to interfaces with a `purpose` of `vpc`.", "properties": { "nat_1_1": { "anyOf": [ @@ -46867,13 +46867,13 @@ } ], "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.\n\n- You can set this to a specific, public IPv4 address that's available on the Linode. You can also use the `any` keyword to enable the Linode's assigned public IPv4 address.\n\n- A specified address can't be used on another Linode.\n\n- Include this as an empty object (`\"\"`) to remove an existing `nat_1_1` value.\n\n- Omit this object or include it and set it to `null` to leave an existing `nat_1_1` value as is.", - "example": "192.0.2.39", + "example": "203.0.113.2", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface.\n\n- The `vpc` can't be assigned to an existing Linode as an address or in a range.\n\n- The target address can't be the first two or last two addresses in the subnet IPv4 range.\n\n- If omitted, a valid address within the subnet IPv4 range is automatically assigned.", - "example": "192.0.2.148", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -46923,8 +46923,8 @@ "ip_ranges": { "description": "IPv4 CIDR VPC subnet ranges that are routed to this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as an empty string (`\"\"`) if the interface has a `purpose` of `public` or `vlan`.", "example": [ - "192.0.2.251/24", - "2001:db8:57f3:e272:6d23:3eaa:6dae:917e/32" + "10.0.0.64/26", + "fd04:495a:691c:971c::1:0/112" ], "items": { "format": "ip", @@ -46934,7 +46934,7 @@ "type": "array" }, "ipam_address": { - "description": "The interface's private IP address, in classless inter-domain routing (CIDR) notation. Only applies to interfaces with a `purpose` of `vlan`. Returned as `null` if the interface has a `purpose` of `public` or `vpc`.\n\n> 📘\n>\n> If Network Helper is enabled, the Linode's interface is automatically configured to use this address after the Linode is rebooted. If Network Helper is disabled, enable the address using [manual static IP configuration](https://www.linode.com/docs/guides/manual-network-configuration/).", + "description": "The interface's private IP address, in classless inter-domain routing (CIDR) notation. Only applies to interfaces with a `purpose` of `vlan`. Returned as `null` if the interface has a `purpose` of `public` or `vpc`.\n\n> \ud83d\udcd8\n>\n> If Network Helper is enabled, the Linode's interface is automatically configured to use this address after the Linode is rebooted. If Network Helper is disabled, enable the address using [manual static IP configuration](https://www.linode.com/docs/guides/manual-network-configuration/).", "example": "10.0.0.1/24", "format": "ip/netmask", "nullable": true, @@ -46947,14 +46947,14 @@ "properties": { "nat_1_1": { "description": "The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface's VPC subnet IPv4 address. This only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if no 1:1 NAT is set for a `vpc` interface. Returned as an empty string (`\"\"`) if the interface has a `purpose` of `public` or `vlan`.", - "example": "192.0.2.161", + "example": "203.0.113.2", "format": "ip", "nullable": true, "type": "string" }, "vpc": { "description": "The VPC subnet IPv4 address for this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as an empty string (`\"\"`) if the interface has a `purpose` of `public` or `vlan`.", - "example": "192.0.2.36", + "example": "10.0.0.2", "format": "ip", "nullable": true, "type": "string" @@ -46979,7 +46979,7 @@ "x-linode-filterable": true }, "primary": { - "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. Defaults to the first non-`vlan` type interface, if you haven't specifically set a `primary`.\n\n> 📘\n>\n> The value needs to `false` for any interface that uses `vlan` as its `purpose`.", + "description": "The default route to the Linode. Each Linode can have one interface set as its `primary`. Defaults to the first non-`vlan` type interface, if you haven't specifically set a `primary`.\n\n> \ud83d\udcd8\n>\n> The value needs to `false` for any interface that uses `vlan` as its `purpose`.", "example": true, "type": "boolean" }, @@ -46995,7 +46995,7 @@ "x-linode-cli-display": 3 }, "subnet_id": { - "description": "The `id` of the VPC subnet for this interface. Only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if the interface has a `purpose` of `public` or `vlan`.\n\n> 📘\n>\n> You need to reboot a Linode using the interface's configuration profile to assign the Linode to a VPC subnet.", + "description": "The `id` of the VPC subnet for this interface. Only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if the interface has a `purpose` of `public` or `vlan`.\n\n> \ud83d\udcd8\n>\n> You need to reboot a Linode using the interface's configuration profile to assign the Linode to a VPC subnet.", "example": 101, "nullable": true, "type": "integer" @@ -47303,7 +47303,7 @@ "writeOnly": true }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -47416,7 +47416,7 @@ "x-linode-cli-display": 6 }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -47637,7 +47637,7 @@ "x-linode-cli-display": 6 }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -47887,7 +47887,7 @@ "x-linode-cli-display": 6 }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -48105,7 +48105,7 @@ "x-linode-cli-display": 6 }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -48437,7 +48437,7 @@ "x-linode-cli-display": 6 }, "filesystem": { - "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> 📘\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", + "description": "The disk's format or file system. A value of `raw` indicates no file system, just a raw binary stream. A value of `swap` indicates a Linux swap area. The values `ext3` or `ext4` represent these Linux journaling file systems. The value `ext2` is the deprecated ext2 Linux file system. Finally, `initrd` indicates the disk is formatted as an uncompressed initial RAM disk.\n\n> \ud83d\udcd8\n>\n> The `ext2` file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, `initrd` is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.", "enum": [ "raw", "swap", @@ -49123,7 +49123,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.130/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -49215,7 +49215,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.67/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -49669,7 +49669,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.13", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -49677,7 +49677,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.72", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -49719,7 +49719,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.205", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -49739,11 +49739,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.102", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -49845,7 +49845,7 @@ "x-linode-grant": "read_write" }, "get": { - "description": "Returns networking information for a single Linode.\n\n> 📘\n>\n> If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, the response lists address information for all of the VPCs.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes ips-list 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns networking information for a single Linode.\n\n> \ud83d\udcd8\n>\n> If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, the response lists address information for all of the VPCs.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli linodes ips-list 123\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-linode-ips" @@ -49870,7 +49870,7 @@ "properties": { "address": { "description": "__Read-only__ The private IPv4 address.", - "example": "192.0.2.41", + "example": "192.168.133.234", "format": "ip", "readOnly": true, "type": "string", @@ -49920,7 +49920,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.115", + "example": "255.255.128.0", "format": "ip", "readOnly": true, "type": "string" @@ -49949,7 +49949,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.152", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -49957,7 +49957,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.2", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -49999,7 +49999,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.152", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -50019,11 +50019,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.108", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -50060,7 +50060,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.232", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -50068,7 +50068,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.50", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -50110,7 +50110,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.202", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -50130,11 +50130,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.247", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -50171,7 +50171,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.179", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -50179,7 +50179,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.174", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -50221,7 +50221,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.72", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -50241,11 +50241,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.152", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -50348,7 +50348,7 @@ }, "nat_1_1": { "description": "__Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used.", - "example": "192.0.2.29", + "example": "192.168.0.42", "format": "ip", "readOnly": true, "type": "string" @@ -50382,7 +50382,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`.", - "example": "192.0.2.169", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -50431,7 +50431,7 @@ }, "range": { "description": "__Read-only__ The IPv6 address of this range.", - "example": "2001:db8:79ea:9876:4fff:bc8e:4918:9716", + "example": "2600:3c01::", "readOnly": true, "type": "string", "x-linode-cli-display": 1 @@ -50445,7 +50445,7 @@ }, "route_target": { "description": "The IPv6 SLAAC address.", - "example": "2001:db8:122:d755:3006:34c:9e5a:dc1f", + "example": "2600:3c01::ffff:ffff:ffff:ffff", "type": "string" } }, @@ -50462,7 +50462,7 @@ "properties": { "address": { "description": "__Read-only__ The IPv6 link-local address.", - "example": "2001:db8:3536:c7a:5ad4:487f:eb95:163", + "example": "fe80::f03c:91ff:fe24:3a2f", "format": "ip", "readOnly": true, "type": "string", @@ -50470,7 +50470,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "2001:db8:5a43:f546:447c:e80b:ec9b:e0bb", + "example": "fe80::1", "readOnly": true, "type": "string" }, @@ -50516,7 +50516,7 @@ }, "subnet_mask": { "description": "__Read-only__ The subnet mask.", - "example": "2001:db8:2386:f7f7:717c:c3d2:85e8:3bb", + "example": "ffff:ffff:ffff:ffff::", "format": "ip", "readOnly": true, "type": "string" @@ -50540,7 +50540,7 @@ "properties": { "address": { "description": "__Read-only__ The address.", - "example": "2001:db8:7b4:d8f2:b7ad:264a:cbe7:9c08", + "example": "2600:3c03::f03c:91ff:fe24:3a2f", "format": "ip", "readOnly": true, "type": "string", @@ -50548,7 +50548,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "2001:db8:6751:2bdf:d0ae:8e89:5238:f39c", + "example": "fe80::1", "readOnly": true, "type": "string" }, @@ -50594,7 +50594,7 @@ }, "subnet_mask": { "description": "__Read-only__ The subnet mask.", - "example": "2001:db8:792e:6e26:6a99:1d9d:b413:1676", + "example": "ffff:ffff:ffff:ffff::", "format": "ip", "readOnly": true, "type": "string" @@ -50764,7 +50764,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.141", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -50772,7 +50772,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.136", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -50814,7 +50814,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.135", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -50834,11 +50834,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.58", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -50984,7 +50984,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.106", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -50992,7 +50992,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.243", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -51034,7 +51034,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.232", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -51054,11 +51054,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.205", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -51707,7 +51707,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.135", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -52624,7 +52624,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.28", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -52643,7 +52643,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:2432:88e4:d43f:83ee:f85f:3fee/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -52697,7 +52697,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -52707,7 +52707,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -57277,7 +57277,7 @@ "type": "object" }, "class": { - "description": "__Filterable__, __Read-only__ The class of the Linode type.\n\n- `nanode`. These instances are good for low-duty workloads, where performance isn't critical.\n\n- `standard`. These instances are good for medium-duty workloads, and offer a good mix of performance, resources, and price.\n\n- `dedicated`. These instances are good for full-duty workloads where consistent performance is important.\n\n- `premium` (limited regions). This includes the features of a `dedicated` instance as well as the latest AMD EPYC™ CPUs. This ensures your applications are running on the latest hardware with consistently high performance. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with \"Premium Plans\" in their `capabilities`.\n\n- `gpu` (limited regions). Linodes with dedicated NVIDIA Quadro® RTX 6000 GPUs accelerate highly specialized applications such as machine learning, AI, and video transcoding. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with `GPU Linodes` in their `capabilities`.\n\n- `accelerated` (limited regions - **Beta**). These leverage the power of dedicated, application-specific integrated circuits (ASIC), starting with NETINT Video Processing Units (VPUs). They're ideal for video transcoding, media processing, and other compute-heavy workloads. Designed to offload specialized tasks, these instances deliver faster processing times and greater efficiency than traditional CPU-based solutions.\n\n- `highmem`. High Memory instances favor RAM over other resources, and can be good for memory hungry use cases like caching and in-memory databases. All High Memory plans contain dedicated CPU cores.\n\n> 📘\n>\n> - A `nanode` class is listed as a 1 GB Linode in Cloud Manager. The API, the CLI, and billing continue to refer to these as a Nanode.\n>\n> - A `standard` class is listed as a Shared Linode in Cloud Manager. The API, the CLI, and billing still refer to these as Standard.\n>\n> - The `accelerated` Linode type is in **Beta**. Talk to your account team or [open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket).", + "description": "__Filterable__, __Read-only__ The class of the Linode type.\n\n- `nanode`. These instances are good for low-duty workloads, where performance isn't critical.\n\n- `standard`. These instances are good for medium-duty workloads, and offer a good mix of performance, resources, and price.\n\n- `dedicated`. These instances are good for full-duty workloads where consistent performance is important.\n\n- `premium` (limited regions). This includes the features of a `dedicated` instance as well as the latest AMD EPYC™ CPUs. This ensures your applications are running on the latest hardware with consistently high performance. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with \"Premium Plans\" in their `capabilities`.\n\n- `gpu` (limited regions). Linodes with dedicated NVIDIA Quadro® RTX 6000 GPUs accelerate highly specialized applications such as machine learning, AI, and video transcoding. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with `GPU Linodes` in their `capabilities`.\n\n- `accelerated` (limited regions - **Beta**). These leverage the power of dedicated, application-specific integrated circuits (ASIC), starting with NETINT Video Processing Units (VPUs). They're ideal for video transcoding, media processing, and other compute-heavy workloads. Designed to offload specialized tasks, these instances deliver faster processing times and greater efficiency than traditional CPU-based solutions.\n\n- `highmem`. High Memory instances favor RAM over other resources, and can be good for memory hungry use cases like caching and in-memory databases. All High Memory plans contain dedicated CPU cores.\n\n> \ud83d\udcd8\n>\n> - A `nanode` class is listed as a 1 GB Linode in Cloud Manager. The API, the CLI, and billing continue to refer to these as a Nanode.\n>\n> - A `standard` class is listed as a Shared Linode in Cloud Manager. The API, the CLI, and billing still refer to these as Standard.\n>\n> - The `accelerated` Linode type is in **Beta**. Talk to your account team or [open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket).", "enum": [ "nanode", "standard", @@ -57638,7 +57638,7 @@ "type": "object" }, "class": { - "description": "__Filterable__, __Read-only__ The class of the Linode type.\n\n- `nanode`. These instances are good for low-duty workloads, where performance isn't critical.\n\n- `standard`. These instances are good for medium-duty workloads, and offer a good mix of performance, resources, and price.\n\n- `dedicated`. These instances are good for full-duty workloads where consistent performance is important.\n\n- `premium` (limited regions). This includes the features of a `dedicated` instance as well as the latest AMD EPYC™ CPUs. This ensures your applications are running on the latest hardware with consistently high performance. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with \"Premium Plans\" in their `capabilities`.\n\n- `gpu` (limited regions). Linodes with dedicated NVIDIA Quadro® RTX 6000 GPUs accelerate highly specialized applications such as machine learning, AI, and video transcoding. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with `GPU Linodes` in their `capabilities`.\n\n- `accelerated` (limited regions - **Beta**). These leverage the power of dedicated, application-specific integrated circuits (ASIC), starting with NETINT Video Processing Units (VPUs). They're ideal for video transcoding, media processing, and other compute-heavy workloads. Designed to offload specialized tasks, these instances deliver faster processing times and greater efficiency than traditional CPU-based solutions.\n\n- `highmem`. High Memory instances favor RAM over other resources, and can be good for memory hungry use cases like caching and in-memory databases. All High Memory plans contain dedicated CPU cores.\n\n> 📘\n>\n> - A `nanode` class is listed as a 1 GB Linode in Cloud Manager. The API, the CLI, and billing continue to refer to these as a Nanode.\n>\n> - A `standard` class is listed as a Shared Linode in Cloud Manager. The API, the CLI, and billing still refer to these as Standard.\n>\n> - The `accelerated` Linode type is in **Beta**. Talk to your account team or [open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket).", + "description": "__Filterable__, __Read-only__ The class of the Linode type.\n\n- `nanode`. These instances are good for low-duty workloads, where performance isn't critical.\n\n- `standard`. These instances are good for medium-duty workloads, and offer a good mix of performance, resources, and price.\n\n- `dedicated`. These instances are good for full-duty workloads where consistent performance is important.\n\n- `premium` (limited regions). This includes the features of a `dedicated` instance as well as the latest AMD EPYC™ CPUs. This ensures your applications are running on the latest hardware with consistently high performance. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with \"Premium Plans\" in their `capabilities`.\n\n- `gpu` (limited regions). Linodes with dedicated NVIDIA Quadro® RTX 6000 GPUs accelerate highly specialized applications such as machine learning, AI, and video transcoding. Only available in [regions](https://techdocs.akamai.com/linode-api/reference/get-regions) with `GPU Linodes` in their `capabilities`.\n\n- `accelerated` (limited regions - **Beta**). These leverage the power of dedicated, application-specific integrated circuits (ASIC), starting with NETINT Video Processing Units (VPUs). They're ideal for video transcoding, media processing, and other compute-heavy workloads. Designed to offload specialized tasks, these instances deliver faster processing times and greater efficiency than traditional CPU-based solutions.\n\n- `highmem`. High Memory instances favor RAM over other resources, and can be good for memory hungry use cases like caching and in-memory databases. All High Memory plans contain dedicated CPU cores.\n\n> \ud83d\udcd8\n>\n> - A `nanode` class is listed as a 1 GB Linode in Cloud Manager. The API, the CLI, and billing continue to refer to these as a Nanode.\n>\n> - A `standard` class is listed as a Shared Linode in Cloud Manager. The API, the CLI, and billing still refer to these as Standard.\n>\n> - The `accelerated` Linode type is in **Beta**. Talk to your account team or [open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket).", "enum": [ "nanode", "standard", @@ -57943,7 +57943,7 @@ "ipv4": { "description": "A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to `[]`.", "example": [ - "192.0.2.64", + "203.0.113.1", "192.0.2.0/24" ], "items": { @@ -58004,7 +58004,7 @@ "x-linode-filterable": true }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "{{label}}", "maxLength": 32, "minLength": 1, @@ -58056,7 +58056,7 @@ "type": "integer" }, "disks": { - "description": "This node pool's custom disk layout. Each item in this array will create a new disk partition for each node in this node pool.\n\n> 📘\n>\n> Omit this field, except for special use cases. The disks specified here are partitions in _addition_ to the primary partition and reduce the size of the primary partition. This can lead to stability problems for the node.\n\n - The custom disk layout is applied to each node in this node pool.\n\n - The maximum number of custom disk partitions that can be configured is 7.\n\n - Once the requested disk partitions are allocated, the remaining disk space is allocated to the node's boot disk.\n\n - A node pool's custom disk layout is immutable over the lifetime of the node pool.", + "description": "This node pool's custom disk layout. Each item in this array will create a new disk partition for each node in this node pool.\n\n> \ud83d\udcd8\n>\n> Omit this field, except for special use cases. The disks specified here are partitions in _addition_ to the primary partition and reduce the size of the primary partition. This can lead to stability problems for the node.\n\n - The custom disk layout is applied to each node in this node pool.\n\n - The maximum number of custom disk partitions that can be configured is 7.\n\n - Once the requested disk partitions are allocated, the remaining disk space is allocated to the node's boot disk.\n\n - A node pool's custom disk layout is immutable over the lifetime of the node pool.", "items": { "additionalProperties": false, "description": "The values to assign to each partition in this Node Pool's custom disk layout.", @@ -58213,7 +58213,7 @@ "x-linode-filterable": true }, "tier": { - "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> 🚧\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", + "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> \ud83d\udea7\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", "enum": [ "standard", "enterprise" @@ -58300,7 +58300,7 @@ "x-linode-filterable": true }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "lkecluster12345", "maxLength": 32, "minLength": 1, @@ -58343,7 +58343,7 @@ "x-linode-filterable": true }, "tier": { - "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> 🚧\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", + "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> \ud83d\udea7\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", "enum": [ "standard", "enterprise" @@ -58508,7 +58508,7 @@ "x-linode-filterable": true }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "lkecluster12345", "maxLength": 32, "minLength": 1, @@ -58551,7 +58551,7 @@ "x-linode-filterable": true }, "tier": { - "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> 🚧\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", + "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> \ud83d\udea7\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", "enum": [ "standard", "enterprise" @@ -58763,7 +58763,7 @@ "x-linode-filterable": true }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "lkecluster12345", "maxLength": 32, "minLength": 1, @@ -58806,7 +58806,7 @@ "x-linode-filterable": true }, "tier": { - "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> 🚧\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", + "description": "__Beta__, __Filterable__ The desired Kubernetes tier.\n\n> \ud83d\udea7\n>\n> This field is in beta and only works when using the beta API. Call the URL with the `apiVersion` path parameter set to `v4beta`.", "enum": [ "standard", "enterprise" @@ -58937,7 +58937,7 @@ "ipv4": { "description": "A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to `[]`.", "example": [ - "192.0.2.182", + "203.0.113.1", "192.0.2.0/24" ], "items": { @@ -58988,7 +58988,7 @@ "type": "string" }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "{{label}}", "maxLength": 32, "minLength": 1, @@ -59054,7 +59054,7 @@ "x-linode-filterable": true }, "label": { - "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _か_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", + "description": "__Filterable__ This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:\n\n - UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character _\u304b_ is 3 bytes in UTF-8 (`0xE382AB`). Its Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point (`\"\\u30ab\"`).\n\n - 4 byte UTF-8 characters are not supported.\n\n - If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.", "example": "lkecluster12345", "maxLength": 32, "minLength": 1, @@ -59443,7 +59443,7 @@ }, "/{apiVersion}/lke/clusters/{clusterId}/control_plane_acl": { "get": { - "description": "Get a specific cluster's control plane access control List.\n\n> 📘\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-view 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Get a specific cluster's control plane access control List.\n\n> \ud83d\udcd8\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-view 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-lke-cluster-acl" @@ -59468,7 +59468,7 @@ "ipv4": { "description": "A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to `[]`.", "example": [ - "192.0.2.168", + "203.0.113.1", "192.0.2.0/24" ], "items": { @@ -59689,7 +59689,7 @@ "x-linode-cli-action": "cluster-acl-view" }, "put": { - "description": "Updates a specific cluster's control plane access control list.\n\n> 📘\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-update 12345 \\\n --acl.enabled true \\\n --acl.addresses.ipv4 \"203.0.113.1\" \\\n --acl.addresses.ipv6 \"2001:db8:1234:abcd::/64\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Updates a specific cluster's control plane access control list.\n\n> \ud83d\udcd8\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-update 12345 \\\n --acl.enabled true \\\n --acl.addresses.ipv4 \"203.0.113.1\" \\\n --acl.addresses.ipv6 \"2001:db8:1234:abcd::/64\"\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-lke-cluster-acl" @@ -59713,7 +59713,7 @@ "ipv4": { "description": "A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to `[]`.", "example": [ - "192.0.2.183", + "203.0.113.1", "192.0.2.0/24" ], "items": { @@ -59777,7 +59777,7 @@ "ipv4": { "description": "A list of individual ipv4 addresses or CIDRs to ALLOW. Defaults to `[]`.", "example": [ - "192.0.2.103", + "203.0.113.1", "192.0.2.0/24" ], "items": { @@ -59998,7 +59998,7 @@ "x-linode-cli-action": "cluster-acl-update" }, "delete": { - "description": "Disable control plane access controls and deletes all rules. This has the same effect as calling `PUT` with an acl json map value of `{“enabled” : false}`. \n\n> 📘\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Disable control plane access controls and deletes all rules. This has the same effect as calling `PUT` with an acl json map value of `{\u201cenabled\u201d : false}`. \n\n> \ud83d\udcd8\n>\n> Currently, control plane ACLs may not be available to all users.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke cluster-acl-delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-acl" @@ -61034,7 +61034,7 @@ "type": "integer" }, "disks": { - "description": "This node pool's custom disk layout. Each item in this array will create a new disk partition for each node in this node pool.\n\n> 📘\n>\n> Omit this field, except for special use cases. The disks specified here are partitions in _addition_ to the primary partition and reduce the size of the primary partition. This can lead to stability problems for the node.\n\n - The custom disk layout is applied to each node in this node pool.\n\n - The maximum number of custom disk partitions that can be configured is 7.\n\n - Once the requested disk partitions are allocated, the remaining disk space is allocated to the node's boot disk.\n\n - A node pool's custom disk layout is immutable over the lifetime of the node pool.", + "description": "This node pool's custom disk layout. Each item in this array will create a new disk partition for each node in this node pool.\n\n> \ud83d\udcd8\n>\n> Omit this field, except for special use cases. The disks specified here are partitions in _addition_ to the primary partition and reduce the size of the primary partition. This can lead to stability problems for the node.\n\n - The custom disk layout is applied to each node in this node pool.\n\n - The maximum number of custom disk partitions that can be configured is 7.\n\n - Once the requested disk partitions are allocated, the remaining disk space is allocated to the node's boot disk.\n\n - A node pool's custom disk layout is immutable over the lifetime of the node pool.", "items": { "additionalProperties": false, "description": "The values to assign to each partition in this Node Pool's custom disk layout.", @@ -62918,7 +62918,7 @@ }, "/{apiVersion}/lke/clusters/{clusterId}/regenerate": { "post": { - "description": "Regenerate the Kubeconfig file and/or the service account token for a Cluster.\n\nThis is a helper operation that allows performing both the [Delete a Kubeconfig](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-kubeconfig) and the [Delete a service token](https://techdocs.akamai.com/linode-api/reference/delete-lke-service-token) operations with a single request.\n\nWhen using this operation, at least one of `kubeconfig` or `servicetoken` is required.\n\n> 📘\n>\n> When regenerating a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke regenerate 12345 \\\n --kubeconfig true \\\n --servicetoken true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Regenerate the Kubeconfig file and/or the service account token for a Cluster.\n\nThis is a helper operation that allows performing both the [Delete a Kubeconfig](https://techdocs.akamai.com/linode-api/reference/delete-lke-cluster-kubeconfig) and the [Delete a service token](https://techdocs.akamai.com/linode-api/reference/delete-lke-service-token) operations with a single request.\n\nWhen using this operation, at least one of `kubeconfig` or `servicetoken` is required.\n\n> \ud83d\udcd8\n>\n> When regenerating a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke regenerate 12345 \\\n --kubeconfig true \\\n --servicetoken true\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-lke-cluster-regenerate" @@ -63081,7 +63081,7 @@ }, "/{apiVersion}/lke/clusters/{clusterId}/servicetoken": { "delete": { - "description": "Delete and regenerate the service account token for a Cluster.\n\n> 📘\n>\n> When you regenerate a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke service-token-delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Delete and regenerate the service account token for a Cluster.\n\n> \ud83d\udcd8\n>\n> When you regenerate a service account token, the cluster's control plane components and Linode CSI drivers are also restarted and configured with the new token. High availability clusters shouldn't experience any disruption, while standard clusters may experience brief control plane downtime while components are restarted.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli lke service-token-delete 12345\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n lke:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-lke-service-token" @@ -68568,7 +68568,7 @@ "ip": { "default": "any", "description": "The IP Linode special forces should use to access this Linode when responding to an Issue.\n\nBy default, any of a Linode's IP addresses can be used for incident response access.", - "example": "192.0.2.207", + "example": "203.0.113.1", "format": "ip", "type": "string" }, @@ -68777,7 +68777,7 @@ "ip": { "default": "any", "description": "The IP Linode special forces should use to access this Linode when responding to an Issue.\n\nBy default, any of a Linode's IP addresses can be used for incident response access.", - "example": "192.0.2.46", + "example": "203.0.113.1", "format": "ip", "type": "string" }, @@ -68933,7 +68933,7 @@ "ip": { "default": "any", "description": "The IP Linode special forces should use to access this Linode when responding to an Issue.\n\nBy default, any of a Linode's IP addresses can be used for incident response access.", - "example": "192.0.2.109", + "example": "203.0.113.1", "format": "ip", "type": "string" }, @@ -69016,7 +69016,7 @@ "ip": { "default": "any", "description": "The IP Linode special forces should use to access this Linode when responding to an Issue.\n\nBy default, any of a Linode's IP addresses can be used for incident response access.", - "example": "192.0.2.170", + "example": "203.0.113.1", "format": "ip", "type": "string" }, @@ -71556,7 +71556,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.12/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -71648,7 +71648,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.131/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -71927,7 +71927,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.159/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -72019,7 +72019,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.188/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -72354,7 +72354,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.23/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -72446,7 +72446,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.54/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -72798,7 +72798,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.119/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -72890,7 +72890,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.128/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -73248,7 +73248,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.177/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -73340,7 +73340,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.11/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -74644,7 +74644,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.112/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -74736,7 +74736,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.135/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75073,7 +75073,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.234/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75165,7 +75165,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.157/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75470,7 +75470,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.51/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75562,7 +75562,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.11/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75769,7 +75769,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.216/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -75861,7 +75861,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.207/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -76008,7 +76008,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.67/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -76100,7 +76100,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.15/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -76362,7 +76362,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.155", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -76370,7 +76370,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.213", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -76412,7 +76412,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.119", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -76432,11 +76432,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.60", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -76538,7 +76538,7 @@ "x-linode-grant": "read_write" }, "get": { - "description": "Returns a paginated list of IP addresses on your account, excluding private addresses.\n\n> 👍\n>\n> if your application frequently accesses this operation and doesn't require IPv6 RDNS data, you can use the `skip_ipv6_rdns` query string to improve performance.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ips-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of IP addresses on your account, excluding private addresses.\n\n> \ud83d\udc4d\n>\n> if your application frequently accesses this operation and doesn't require IPv6 RDNS data, you can use the `skip_ipv6_rdns` query string to improve performance.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ips-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-ips" @@ -76701,7 +76701,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.143", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -76727,11 +76727,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this interface. Empty if no address is configured as a 1:1 NAT.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this interface. Empty if no address is configured as a 1:1 NAT.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.147", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -76864,7 +76864,7 @@ }, "/{apiVersion}/networking/ips/assign": { "post": { - "description": "Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n\n- All Linodes involved must have at least one public IPv4 address after assignment.\n- Linodes may have no more than one assigned private IPv4 address.\n- Linodes may have no more than one assigned IPv6 range.\n- Shared IP addresses cannot be swapped between Linodes.\n\n[Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n> 📘\n>\n> Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values.\n\nTo view and configure Managed Linode SSH settings, use the following operations:\n\n- [Get a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-setting)\n- [Update a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/put-managed-linode-setting)\n\n> 📘\n>\n> Addresses with an active 1:1 NAT to a VPC Interface address cannot be assigned to other Linodes.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ip-assign \\\n --region us-east \\\n --assignments.address 192.0.2.1 \\\n --assignments.linode_id 123 \\\n --assignments.address 2001:db8:3c4d:15::/64 \\\n --assignments.linode_id 234\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n\n- All Linodes involved must have at least one public IPv4 address after assignment.\n- Linodes may have no more than one assigned private IPv4 address.\n- Linodes may have no more than one assigned IPv6 range.\n- Shared IP addresses cannot be swapped between Linodes.\n\n[Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n> \ud83d\udcd8\n>\n> Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values.\n\nTo view and configure Managed Linode SSH settings, use the following operations:\n\n- [Get a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-setting)\n- [Update a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/put-managed-linode-setting)\n\n> \ud83d\udcd8\n>\n> Addresses with an active 1:1 NAT to a VPC Interface address cannot be assigned to other Linodes.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ip-assign \\\n --region us-east \\\n --assignments.address 192.0.2.1 \\\n --assignments.linode_id 123 \\\n --assignments.address 2001:db8:3c4d:15::/64 \\\n --assignments.linode_id 234\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-assign-ips" @@ -77040,7 +77040,7 @@ }, "/{apiVersion}/networking/ips/share": { "post": { - "description": "Configure shared IPs.\n\nIP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.\n\nIP failover requires configuration of a [BGP based failover service](https://techdocs.akamai.com/cloud-computing/docs/configure-failover-on-a-compute-instance) within the internal system of the primary Linode.\n\n> 📘\n>\n> A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a `vpc` purpose Configuration Profile Interface.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ip-share \\\n --linode_id 123 \\\n --ips 192.0.2.1 \\\n --ips 2001:db8:3c4d:15::\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Configure shared IPs.\n\nIP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.\n\nIP failover requires configuration of a [BGP based failover service](https://techdocs.akamai.com/cloud-computing/docs/configure-failover-on-a-compute-instance) within the internal system of the primary Linode.\n\n> \ud83d\udcd8\n>\n> A public IPv4 address can't be shared if it's configured for a 1:1 NAT on a `vpc` purpose Configuration Profile Interface.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking ip-share \\\n --linode_id 123 \\\n --ips 192.0.2.1 \\\n --ips 2001:db8:3c4d:15::\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-share-ips" @@ -77224,7 +77224,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.120", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -77232,7 +77232,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.52", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -77274,7 +77274,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.24", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -77294,11 +77294,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.204", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -77446,7 +77446,7 @@ "properties": { "address": { "description": "__Read-only__ The IP address.", - "example": "192.0.2.153", + "example": "97.107.143.141", "format": "ip", "readOnly": true, "type": "string", @@ -77454,7 +77454,7 @@ }, "gateway": { "description": "__Read-only__ The default gateway for this address.", - "example": "192.0.2.188", + "example": "97.107.143.1", "format": "ip", "nullable": true, "readOnly": true, @@ -77496,7 +77496,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for this address.", - "example": "192.0.2.171", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -77516,11 +77516,11 @@ }, "vpc_nat_1_1": { "additionalProperties": false, - "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> 📘\n>\n> Only allowed for `vpc` type interfaces.", + "description": "IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned.\n\n> \ud83d\udcd8\n>\n> Only allowed for `vpc` type interfaces.", "properties": { "address": { "description": "The IPv4 address that is configured as a 1:1 NAT for this VPC interface.", - "example": "192.0.2.151", + "example": "192.168.0.42", "format": "ipv4", "type": "string" }, @@ -77662,7 +77662,7 @@ }, "/{apiVersion}/networking/ipv4/assign": { "post": { - "description": "This operation is equivalent to [Assign IP addresses](https://techdocs.akamai.com/linode-api/reference/post-assign-ips).\n\nAssign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n\n- All Linodes involved must have at least one public IPv4 address after assignment.\n- Linodes may have no more than one assigned private IPv4 address.\n- Linodes may have no more than one assigned IPv6 range.\n\n[Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n> 📘\n>\n> Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values.\n\nTo view and configure Managed Linode SSH settings, use the following operations:\n- [Get a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-setting)\n- [Update a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/put-managed-linode-setting)\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "This operation is equivalent to [Assign IP addresses](https://techdocs.akamai.com/linode-api/reference/post-assign-ips).\n\nAssign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.\n\nThe following restrictions apply:\n\n- All Linodes involved must have at least one public IPv4 address after assignment.\n- Linodes may have no more than one assigned private IPv4 address.\n- Linodes may have no more than one assigned IPv6 range.\n\n[Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.\n\n> \ud83d\udcd8\n>\n> Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values.\n\nTo view and configure Managed Linode SSH settings, use the following operations:\n- [Get a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/get-managed-linode-setting)\n- [Update a Linode's managed settings](https://techdocs.akamai.com/linode-api/reference/put-managed-linode-setting)\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s" @@ -78051,7 +78051,7 @@ }, "range": { "description": "__Read-only__ The IPv6 range of addresses in this pool.", - "example": "2001:db8:e26b:383:17a0:5bcc:d57b:464", + "example": "2600:3c01::2:5000:0", "readOnly": true, "type": "string", "x-linode-cli-display": 1 @@ -78071,7 +78071,7 @@ }, "route_target": { "description": "The last address in this block of IPv6 addresses.", - "example": "2001:db8:e9fc:f17c:1bb1:f84c:923d:55ce", + "example": "2600:3c01::2:5000:f", "nullable": true, "type": "string" } @@ -78208,7 +78208,7 @@ }, "/{apiVersion}/networking/ipv6/ranges": { "post": { - "description": "Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when running the [Get a Linode](https://techdocs.akamai.com/linode-api/reference/get-linode-instance) operation to view a Linode's IPv6 SLAAC address.\n\n- Either `linode_id` or `route_target` is required in a request.\n- `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.\n- Upon a successful request, an IPv6 range is created in the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) that corresponds to the provided `linode_id` or `route_target`.\n- Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.\n- Run the [Assign IP addresses](https://techdocs.akamai.com/linode-api/reference/post-assign-ips) operation to re-assign IPv6 Ranges to your Linodes.\n\n> 📘\n>\n> - A Linode can only have one IPv6 range targeting its SLAAC address.\n> - An account can only have one IPv6 range in each [region](https://techdocs.akamai.com/linode-api/reference/get-regions).\n> - [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request expansion of these restrictions.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking v6-range-create \\\n --linode_id 123 \\\n --prefix_length 64\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address. See the `ipv6` property when running the [Get a Linode](https://techdocs.akamai.com/linode-api/reference/get-linode-instance) operation to view a Linode's IPv6 SLAAC address.\n\n- Either `linode_id` or `route_target` is required in a request.\n- `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.\n- Upon a successful request, an IPv6 range is created in the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) that corresponds to the provided `linode_id` or `route_target`.\n- Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.\n- Run the [Assign IP addresses](https://techdocs.akamai.com/linode-api/reference/post-assign-ips) operation to re-assign IPv6 Ranges to your Linodes.\n\n> \ud83d\udcd8\n>\n> - A Linode can only have one IPv6 range targeting its SLAAC address.\n> - An account can only have one IPv6 range in each [region](https://techdocs.akamai.com/linode-api/reference/get-regions).\n> - [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) to request expansion of these restrictions.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking v6-range-create \\\n --linode_id 123 \\\n --prefix_length 64\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\nlinodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-ipv6-range" @@ -78235,7 +78235,7 @@ "type": "integer" }, "route_target": { - "description": "The IPv6 SLAAC address to assign this range to.\n\n- __Required__ if `linode_id` is omitted from the request.\n\n- Mutually exclusive with `linode_id`. Submitting values for both properties in a request results in an error.\n\n> 📘\n>\n> You need to omit the `/128` prefix length of the SLAAC address when using this property.", + "description": "The IPv6 SLAAC address to assign this range to.\n\n- __Required__ if `linode_id` is omitted from the request.\n\n- Mutually exclusive with `linode_id`. Submitting values for both properties in a request results in an error.\n\n> \ud83d\udcd8\n>\n> You need to omit the `/128` prefix length of the SLAAC address when using this property.", "example": "{{route_target}}", "format": "ipv6", "type": "string" @@ -78418,7 +78418,7 @@ }, "range": { "description": "__Read-only__ The IPv6 address of this range.", - "example": "2001:db8:5827:2f1b:d9b3:1ae2:a8e8:49f", + "example": "2600:3c01::", "readOnly": true, "type": "string", "x-linode-cli-display": 1 @@ -78432,7 +78432,7 @@ }, "route_target": { "description": "The IPv6 SLAAC address.", - "example": "2001:db8:b18f:dcbb:ad4c:829e:2fce:1f81", + "example": "2600:3c01::ffff:ffff:ffff:ffff", "type": "string" } }, @@ -78608,7 +78608,7 @@ }, "range": { "description": "__Read-only__ The IPv6 address of this range.", - "example": "2001:db8:22f1:c0f9:b6ca:7bfa:367b:6b82", + "example": "2600:3c01::", "readOnly": true, "type": "string", "x-linode-cli-display": 1 @@ -78701,7 +78701,7 @@ "x-linode-cli-action": "v6-range-view" }, "delete": { - "description": "Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.\n\n> 📘\n>\n> You can't delete shared IPv6 ranges. Contact Customer Support for assistance.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking v6-range-delete 2001:0db8::\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.\n\n> \ud83d\udcd8\n>\n> You can't delete shared IPv6 ranges. Contact Customer Support for assistance.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli networking v6-range-delete 2001:0db8::\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-ipv6-range" @@ -78812,7 +78812,7 @@ } }, { - "description": "The IPv6 range to access. Corresponds to the `range` property of objects returned from the [List IPv6 ranges](https://techdocs.akamai.com/linode-api/reference/get-ipv6-ranges) operation.\n\n> 📘\n>\n> You need to omit the prefix length of the IPv6 range.", + "description": "The IPv6 range to access. Corresponds to the `range` property of objects returned from the [List IPv6 ranges](https://techdocs.akamai.com/linode-api/reference/get-ipv6-ranges) operation.\n\n> \ud83d\udcd8\n>\n> You need to omit the prefix length of the IPv6 range.", "example": "{{range}}", "in": "path", "name": "range", @@ -78834,7 +78834,7 @@ }, "/{apiVersion}/networking/vlans": { "get": { - "description": "Returns a list of all Virtual Local Area Networks (VLANs) on your Account. VLANs provide a mechanism for secure communication between two or more Linodes that are assigned to the same VLAN and are both within the same Layer 2 broadcast domain.\n\nVLANs are created and attached to Linodes by using the `interfaces` property for the following operations:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config)\n- [Update a config profile](https://techdocs.akamai.com/linode-api/reference/put-linode-config)\n\nThere are several ways to detach a VLAN from a Linode:\n\n- [Update](https://techdocs.akamai.com/linode-api/reference/put-linode-config) the active Configuration Profile to remove the VLAN Interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode.\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config) without the VLAN Interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode into the new Configuration Profile.\n- [Delete](https://techdocs.akamai.com/linode-api/reference/delete-linode-instance) the Linode.\n\n> 📘\n>\n> - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning won't initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.\n>\n> - See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vlans list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a list of all Virtual Local Area Networks (VLANs) on your Account. VLANs provide a mechanism for secure communication between two or more Linodes that are assigned to the same VLAN and are both within the same Layer 2 broadcast domain.\n\nVLANs are created and attached to Linodes by using the `interfaces` property for the following operations:\n\n- [Create a Linode](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config)\n- [Update a config profile](https://techdocs.akamai.com/linode-api/reference/put-linode-config)\n\nThere are several ways to detach a VLAN from a Linode:\n\n- [Update](https://techdocs.akamai.com/linode-api/reference/put-linode-config) the active Configuration Profile to remove the VLAN Interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode.\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config) without the VLAN Interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode into the new Configuration Profile.\n- [Delete](https://techdocs.akamai.com/linode-api/reference/delete-linode-instance) the Linode.\n\n> \ud83d\udcd8\n>\n> - Only Next Generation Network (NGN) data centers support VLANs. Run the [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) operation to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning won't initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.\n>\n> - See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vlans list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-vlans" @@ -78920,7 +78920,7 @@ "x-linode-cli-display": 3 }, "region": { - "description": "__Filterable__, __Read-only__ This VLAN's data center region.\n\n> 📘\n>\n> Currently, a VLAN can only be assigned to a Linode within the same data center region.", + "description": "__Filterable__, __Read-only__ This VLAN's data center region.\n\n> \ud83d\udcd8\n>\n> Currently, a VLAN can only be assigned to a Linode within the same data center region.", "example": "ap-west", "readOnly": true, "type": "string", @@ -79074,7 +79074,7 @@ }, "/{apiVersion}/networking/vlans/{regionId}/{label}": { "delete": { - "description": "This operation deletes a VLAN. You can't delete a VLAN if it's still attached to a Linode. There are a few ways to detach it:\n- [Update](https://techdocs.akamai.com/linode-api/reference/put-linode-config) the active configuration profile to remove the VLAN interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode.\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config) without the VLAN interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode into the new configuration profile.\n- [Delete](https://techdocs.akamai.com/linode-api/reference/delete-linode-instance) the Linode.\n\nTo run this operation, you need `read_write` grants to Linodes that use the VLAN.\n\nA successful request triggers a `vlan_delete` event.\n\n> 📘\n>\n> VLANs without any attached Linodes are periodically cleaned up by the system.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vlans delete $regionId $label\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "This operation deletes a VLAN. You can't delete a VLAN if it's still attached to a Linode. There are a few ways to detach it:\n- [Update](https://techdocs.akamai.com/linode-api/reference/put-linode-config) the active configuration profile to remove the VLAN interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode.\n- [Create a config profile](https://techdocs.akamai.com/linode-api/reference/post-add-linode-config) without the VLAN interface, then [reboot](https://techdocs.akamai.com/linode-api/reference/post-reboot-linode-instance) the Linode into the new configuration profile.\n- [Delete](https://techdocs.akamai.com/linode-api/reference/delete-linode-instance) the Linode.\n\nTo run this operation, you need `read_write` grants to Linodes that use the VLAN.\n\nA successful request triggers a `vlan_delete` event.\n\n> \ud83d\udcd8\n>\n> VLANs without any attached Linodes are periodically cleaned up by the system.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vlans delete $regionId $label\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-vlan" @@ -80193,7 +80193,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.27", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -80501,7 +80501,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.251", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -81062,7 +81062,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.216", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -81527,7 +81527,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.48", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -91795,7 +91795,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.131/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -91887,7 +91887,7 @@ "description": "A list of IPv4 addresses or networks. Addresses must be in IP/mask format. Must not be an empty list.\n\nIf `0.0.0.0/0` is included in this list, all IPv4 addresses are affected by this rule.", "example": [ "192.0.2.0/24", - "192.0.2.21/24" + "198.51.100.2/32" ], "items": { "type": "string" @@ -92319,7 +92319,7 @@ }, "/{apiVersion}/object-storage/buckets": { "post": { - "description": "Creates an Object Storage bucket in the specified data center ([region](https://techdocs.akamai.com/linode-api/reference/get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it.\n\n> 📘\n>\n> - Accounts with negative balances can't access this operation.\n>\n> - The API still supports the `clusterId` equivalent (`us-west-1`) when setting a `region` for a new bucket, but you should use the `regionId` (`us-west`) instead.\n>\n> - You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates an Object Storage bucket in the specified data center ([region](https://techdocs.akamai.com/linode-api/reference/get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it.\n\n> \ud83d\udcd8\n>\n> - Accounts with negative balances can't access this operation.\n>\n> - The API still supports the `clusterId` equivalent (`us-west-1`) when setting a `region` for a new bucket, but you should use the `regionId` (`us-west`) instead.\n>\n> - You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket" @@ -92366,7 +92366,7 @@ "type": "string" }, "region": { - "description": "The `id` assigned to the data center ([region](https://techdocs.akamai.com/linode-api/reference/get-regions)) where this Object Storage bucket should be created.\n\n> 📘\n>\n> This supports legacy `clusterId` values that represented a specific region. For example, `us-east-1` is the legacy reference for the `us-east` region.", + "description": "The `id` assigned to the data center ([region](https://techdocs.akamai.com/linode-api/reference/get-regions)) where this Object Storage bucket should be created.\n\n> \ud83d\udcd8\n>\n> This supports legacy `clusterId` values that represented a specific region. For example, `us-east-1` is the legacy reference for the `us-east` region.", "example": "{{region}}", "type": "string" }, @@ -92402,7 +92402,7 @@ "properties": { "cluster": { "deprecated": true, - "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> 📘\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", + "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> \ud83d\udcd8\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", "example": "us-east-1", "type": "string", "x-akamai": { @@ -92537,7 +92537,7 @@ "x-linode-cli-skip": true }, "get": { - "description": "Returns a paginated list of all Object Storage buckets available in your account.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of all Object Storage buckets available in your account.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets" @@ -92557,7 +92557,7 @@ "properties": { "cluster": { "deprecated": true, - "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> 📘\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", + "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> \ud83d\udcd8\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", "example": "us-east-1", "type": "string", "x-akamai": { @@ -92743,7 +92743,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}": { "get": { - "description": "Returns a list of buckets on your account, in the specified region.\n\n> 📘\n>\n> You can use the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a list of buckets on your account, in the specified region.\n\n> \ud83d\udcd8\n>\n> You can use the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucketin-cluster" @@ -92763,7 +92763,7 @@ "properties": { "cluster": { "deprecated": true, - "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> 📘\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", + "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> \ud83d\udcd8\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", "example": "us-east-1", "type": "string", "x-akamai": { @@ -92942,7 +92942,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -92963,7 +92963,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}/{bucket}": { "get": { - "description": "Returns a single Object Storage bucket.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a single Object Storage bucket.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket" @@ -92979,7 +92979,7 @@ "properties": { "cluster": { "deprecated": true, - "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> 📘\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", + "description": "__Deprecated__ The legacy `clusterId` equivalent for the `regionId` where this bucket lives. The API maintains this for backward compatibility.\n\n> \ud83d\udcd8\n>\n> - This value and the `regionId` are interchangeable when used in requests. Best practice is to use the `regionId`.\n>\n> - This value is empty for newer regions that don't have a legacy `clusterId`.", "example": "us-east-1", "type": "string", "x-akamai": { @@ -93114,7 +93114,7 @@ "x-linode-cli-skip": true }, "delete": { - "description": "Removes a single bucket.\n\n> 📘\n>\n> - You need to remove all objects from a bucket before you can delete it. While you can delete a bucket using the [CLI](https://www.linode.com/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to configure lifecycle policies with an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then delete the bucket.\n>\n> - You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Removes a single bucket.\n\n> \ud83d\udcd8\n>\n> - You need to remove all objects from a bucket before you can delete it. While you can delete a bucket using the [CLI](https://www.linode.com/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to configure lifecycle policies with an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then delete the bucket.\n>\n> - You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-object-storage-bucket" @@ -93225,7 +93225,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -93259,7 +93259,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/access": { "post": { - "description": "Apply basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings.\n\n> 📘\n>\n> You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Apply basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings.\n\n> \ud83d\udcd8\n>\n> You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket-access" @@ -93387,7 +93387,7 @@ "x-linode-cli-skip": true }, "get": { - "description": "View the cross-origin resource sharing (CORS) and [S3 canned access control (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings for a specific Object Storage bucket.\n\n> 📘\n>\n> You can use the S3 API to view more details on [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "View the cross-origin resource sharing (CORS) and [S3 canned access control (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings for a specific Object Storage bucket.\n\n> \ud83d\udcd8\n>\n> You can use the S3 API to view more details on [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-access" @@ -93510,7 +93510,7 @@ "x-linode-cli-skip": true }, "put": { - "description": "Update basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings.\n\n> 📘\n>\n> You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Update basic cross-origin resource sharing (CORS) and [S3 canned access control list (ACL)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) settings.\n\n> \ud83d\udcd8\n>\n> You can use the S3 API for more fine-grained control of the [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) or [S3 canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/managing-acls.html) settings.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-storage-bucket-access" @@ -93656,7 +93656,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -93690,7 +93690,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-acl": { "get": { - "description": "View a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects and specify the level of access granted to those users.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "View a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects and specify the level of access granted to those users.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-acl" @@ -93816,7 +93816,7 @@ "x-linode-cli-skip": true }, "put": { - "description": "Update a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects, and specify the level of access granted to those users.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Update a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects, and specify the level of access granted to those users.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/put-object-storage-bucket-acl" @@ -93966,7 +93966,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -94000,7 +94000,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-list": { "get": { - "description": "Returns the contents of a bucket. The contents are paginated using a `marker`, that's the name of the last object on the previous page. Objects can also be filtered by `prefix` and `delimiter`. See [Filtering and sorting](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) for more information.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns the contents of a bucket. The contents are paginated using a `marker`, that's the name of the last object on the previous page. Objects can also be filtered by `prefix` and `delimiter`. See [Filtering and sorting](https://techdocs.akamai.com/linode-api/reference/filtering-and-sorting) for more information.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content" @@ -94219,7 +94219,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -94253,7 +94253,7 @@ }, "/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-url": { "post": { - "description": "Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body's `method` parameter.\n\n> 📘\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body's `method` parameter.\n\n> \ud83d\udcd8\n>\n> You can use an outside API, such as the [Ceph Object Gateway S3 API](https://docs.ceph.com/en/latest/radosgw/s3/) for more options.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-object-storage-object-url" @@ -94419,7 +94419,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -94815,7 +94815,7 @@ } }, { - "description": "Identifies a region where this bucket lives.\n\n> 📘\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", + "description": "Identifies a region where this bucket lives.\n\n> \ud83d\udcd8\n>\n> You can use a `clusterId` in place of `regionId` in requests for buckets that you created using the legacy version of the API. Run [List clusters](https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster `id`.", "example": "{{regionId}}", "in": "path", "name": "regionId", @@ -94850,7 +94850,7 @@ }, "/{apiVersion}/object-storage/cancel": { "post": { - "description": "Cancel Object Storage on an Account.\n\n> 🚧\n>\n> This removes all buckets and their contents from your Account. This data is irretrievable once removed.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage cancel\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Cancel Object Storage on an Account.\n\n> \ud83d\udea7\n>\n> This removes all buckets and their contents from your Account. This data is irretrievable once removed.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage cancel\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-cancel-object-storage" @@ -94975,7 +94975,7 @@ "/{apiVersion}/object-storage/clusters": { "get": { "deprecated": true, - "description": "__Deprecated__ Returns a paginated list of available Object Storage legacy clusters.\n\n> 📘\n>\n> This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region) instead.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage clusters-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", + "description": "__Deprecated__ Returns a paginated list of available Object Storage legacy clusters.\n\n> \ud83d\udcd8\n>\n> This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region) instead.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage clusters-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-clusters" @@ -95147,7 +95147,7 @@ "/{apiVersion}/object-storage/clusters/{clusterId}": { "get": { "deprecated": true, - "description": "__Deprecated__ Returns a single Object Storage cluster.\n\n> 📘\n>\n> This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region) instead.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage clusters-view us-east-1\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", + "description": "__Deprecated__ Returns a single Object Storage cluster.\n\n> \ud83d\udcd8\n>\n> This displays deprecated `clusterId` values that represent regions used with older versions of the API. It's maintained for backward compatibility. Run [Get a region](https://techdocs.akamai.com/linode-api/reference/get-region) instead.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage clusters-view us-east-1\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-object-storage-cluster" @@ -95280,7 +95280,7 @@ } }, { - "description": "Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API.\n\n> 📘\n>\n> You can use the applicable `regionId`, for example `us-west`, in place of the `clusterId`, for example, `us-west-1`. Run [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.", + "description": "Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API.\n\n> \ud83d\udcd8\n>\n> You can use the applicable `regionId`, for example `us-west`, in place of the `clusterId`, for example, `us-west-1`. Run [List regions](https://techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.", "example": "{{clusterId}}", "in": "path", "name": "clusterId", @@ -95491,11 +95491,12 @@ "x-akamai": { "file-path": "paths/object-storage-endpoints.yaml", "path-info": "/{apiVersion}/object-storage/endpoints" - } + }, + "x-linode-cli-command": "object-storage" }, "/{apiVersion}/object-storage/keys": { "post": { - "description": "Provisions a new Object Storage key for authentication. A successful request triggers an `obj_access_key_create` [event](https://techdocs.akamai.com/linode-api/reference/get-events).\n\n> 📘\n>\n> Accounts with negative balances can't access this operation.\n\n**The `regions` and `region` parameters**\n\nWhen creating an Object Storage key, specify one or more data centers ([regions](https://techdocs.akamai.com/linode-api/reference/get-regions)) where you want to create and manage Object Storage buckets.\n\n- **The `regions` array**. Populate it with `regionId` values. The resulting Object Storage key grants access to list and create new buckets in these regions. This *doesn't* give access to manage content in these buckets. To address this, you can:\n\n - Use the `bucket_access` array instead to grant management access, per bucket.\n\n - Use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to change the access for this key.\n\n- **The `bucket_access` array**. This optional array lets you set up limited keys. Include individual objects naming a `regionId`, the target `bucket_name`, and the `permissions` for the Object Storage key. Use the resulting key to manage content in the `bucket_name`, based on the permission level set. You can also use the key to create new buckets in the named region. However, the key doesn't have access to manage content in the newly created bucket. You can grant it this access using [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/).\n\n- **Combine the two to apply varying levels of access in the key**. For example, set `regions` to `us-west` to give the key bucket list and create access in that region. Then, set up the `bucket_access` array to give access to a specific `bucket_name` in the `us-east` region. The key has access to manage content in that `bucket_name` and list and create buckets in the `us-east` region, too. If you include the same region in both, the settings applied in the `bucket_access` array take precedence. For example, assume you include `us-east` in the `regions` array, expecting to only give bucket list and creation access to that region. If you also set `us-east` as a `region` in the `bucket_access` array, the Object Storage key gives access to manage content in the specified `bucket_name`, and lets you list and create buckets in that region.\n\n**The `cluster` parameter (legacy)**\n\nFor backward compatibility, include the `cluster` parameter to create an Object Storage key. Use the `clusterId` equivalent (us-west-1) instead of the `regionId` (us-west). Leave the `regions` array out. If including the `bucket_access` array to limit access, omit `region` from each object. Use the resulting key in clusters in all supported regions.\n\n> 📘\n>\n> While the API supports this method, you should use the `regions` parameters, instead.\n\n- **Unlimited access**. Omit the `bucket_access` array. The Object Storage key has unlimited cluster access to all buckets, with all permissions.\n\n- **Limited access**. Include the `bucket_access` array. Set the target `bucket_name` and the level of `permissions` for access to that bucket. Use the resulting key to manage content in the named bucket. A limited Object Storage key can [list all buckets](https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) and [create a new bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). However, you can't use the key to perform any actions on a bucket, unless the key has access to it. You can use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to modify a key's access.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage keys-create \\\n --label \"my-object-storage-key\" \\\n --bucket_access '[{\"region\": \"ap-south\", \"bucket_name\": \"bucket-example-1\", \"permissions\": \"read_write\" }]'\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Provisions a new Object Storage key for authentication. A successful request triggers an `obj_access_key_create` [event](https://techdocs.akamai.com/linode-api/reference/get-events).\n\n> \ud83d\udcd8\n>\n> Accounts with negative balances can't access this operation.\n\n**The `regions` and `region` parameters**\n\nWhen creating an Object Storage key, specify one or more data centers ([regions](https://techdocs.akamai.com/linode-api/reference/get-regions)) where you want to create and manage Object Storage buckets.\n\n- **The `regions` array**. Populate it with `regionId` values. The resulting Object Storage key grants access to list and create new buckets in these regions. This *doesn't* give access to manage content in these buckets. To address this, you can:\n\n - Use the `bucket_access` array instead to grant management access, per bucket.\n\n - Use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to change the access for this key.\n\n- **The `bucket_access` array**. This optional array lets you set up limited keys. Include individual objects naming a `regionId`, the target `bucket_name`, and the `permissions` for the Object Storage key. Use the resulting key to manage content in the `bucket_name`, based on the permission level set. You can also use the key to create new buckets in the named region. However, the key doesn't have access to manage content in the newly created bucket. You can grant it this access using [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/).\n\n- **Combine the two to apply varying levels of access in the key**. For example, set `regions` to `us-west` to give the key bucket list and create access in that region. Then, set up the `bucket_access` array to give access to a specific `bucket_name` in the `us-east` region. The key has access to manage content in that `bucket_name` and list and create buckets in the `us-east` region, too. If you include the same region in both, the settings applied in the `bucket_access` array take precedence. For example, assume you include `us-east` in the `regions` array, expecting to only give bucket list and creation access to that region. If you also set `us-east` as a `region` in the `bucket_access` array, the Object Storage key gives access to manage content in the specified `bucket_name`, and lets you list and create buckets in that region.\n\n**The `cluster` parameter (legacy)**\n\nFor backward compatibility, include the `cluster` parameter to create an Object Storage key. Use the `clusterId` equivalent (us-west-1) instead of the `regionId` (us-west). Leave the `regions` array out. If including the `bucket_access` array to limit access, omit `region` from each object. Use the resulting key in clusters in all supported regions.\n\n> \ud83d\udcd8\n>\n> While the API supports this method, you should use the `regions` parameters, instead.\n\n- **Unlimited access**. Omit the `bucket_access` array. The Object Storage key has unlimited cluster access to all buckets, with all permissions.\n\n- **Limited access**. Include the `bucket_access` array. Set the target `bucket_name` and the level of `permissions` for access to that bucket. Use the resulting key to manage content in the named bucket. A limited Object Storage key can [list all buckets](https://techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) and [create a new bucket](https://techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). However, you can't use the key to perform any actions on a bucket, unless the key has access to it. You can use [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to modify a key's access.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli object-storage keys-create \\\n --label \"my-object-storage-key\" \\\n --bucket_access '[{\"region\": \"ap-south\", \"bucket_name\": \"bucket-example-1\", \"permissions\": \"read_write\" }]'\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n object_storage:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-object-storage-keys" @@ -95527,7 +95528,7 @@ "type": "string" }, "region": { - "description": "The region where the `bucket_name` you want the key to access is located.\n\n> 📘\n>\n> If you repeat the same `region` across objects, the response includes a single `s3_endpoint` for this region. Use it to access all `bucket_name` entries.", + "description": "The region where the `bucket_name` you want the key to access is located.\n\n> \ud83d\udcd8\n>\n> If you repeat the same `region` across objects, the response includes a single `s3_endpoint` for this region. Use it to access all `bucket_name` entries.", "example": "us-iad", "type": "string" } @@ -96211,7 +96212,7 @@ "type": "string" }, "regions": { - "description": "Replace the current list of `regions` set in a specific key. Include an existing region to maintain it or leave it out to remove it. If you include new `regions` in the key, they can't be used to manage content in buckets in that specific region. You can grant these keys this access using [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/). Omit this to leave the existing list unchanged.\n\n> 🚧\n>\n> You can't remove a `region` from a limited key's original `bucket_access` list. If you include the `regions` array in this operation, you need to include all existing `region` entries from the `bucket_access` array. Otherwise, the operation fails with an error. Run [Get an Object Storage key](https://techdocs.akamai.com/linode-api/reference/get-object-storage-key) to review current `region` entries in a limited key.", + "description": "Replace the current list of `regions` set in a specific key. Include an existing region to maintain it or leave it out to remove it. If you include new `regions` in the key, they can't be used to manage content in buckets in that specific region. You can grant these keys this access using [bucket policies](https://www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/). Omit this to leave the existing list unchanged.\n\n> \ud83d\udea7\n>\n> You can't remove a `region` from a limited key's original `bucket_access` list. If you include the `regions` array in this operation, you need to include all existing `region` entries from the `bucket_access` array. Otherwise, the operation fails with an error. Run [Get an Object Storage key](https://techdocs.akamai.com/linode-api/reference/get-object-storage-key) to review current `region` entries in a limited key.", "example": [ "us-iad", "fr-par" @@ -96260,7 +96261,7 @@ "type": "string" }, "limited": { - "description": "__Read-only__ Whether this Object Storage key limits access to specific buckets and permissions. Returns `false` if this key grants full access.\n\n> 📘\n>\n> The `bucket_access` array that contains limited Object Storage key settings doesn't appear in this response. Store this key's `id` from the response and run [Get an Object Storage key](https://techdocs.akamai.com/linode-api/reference/get-object-storage-key) to view these settings.", + "description": "__Read-only__ Whether this Object Storage key limits access to specific buckets and permissions. Returns `false` if this key grants full access.\n\n> \ud83d\udcd8\n>\n> The `bucket_access` array that contains limited Object Storage key settings doesn't appear in this response. Store this key's `id` from the response and run [Get an Object Storage key](https://techdocs.akamai.com/linode-api/reference/get-object-storage-key) to view these settings.", "example": true, "readOnly": true, "type": "boolean" @@ -96641,7 +96642,8 @@ "x-akamai": { "file-path": "paths/object-storage-transfer.yaml", "path-info": "/{apiVersion}/object-storage/transfer" - } + }, + "x-linode-cli-command": "object-storage" }, "/{apiVersion}/object-storage/types": { "get": { @@ -96881,7 +96883,7 @@ }, "/{apiVersion}/placement/groups": { "post": { - "description": "Creates a placement group on your account. Placement groups disperse your compute instances across physical machines (hosts) in one of our compute regions. Depending on your workload requirements, you may need your compute instances to follow specific strategies:\n\n- __Grouped together__. You may want them placed close together to reduce latency between compute instances that are used for an application or workload.\n- __Spread apart__. You may want to disperse them across several hosts to support high availability, for example when required for failover.\n\n<>\n\n> 📘\n>\n> - For this request to complete successfully, your user needs to have the `add_placement` grant.\n> - We offer an [example API workflow](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#create-a-placement-group) you can follow to create a placement group.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli placement group-create \\\n --label PG_Miami_failover \\\n --region us-mia \\\n --placement_group_type \"anti-affinity:local\" \\\n --placement_group_policy strict\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Creates a placement group on your account. Placement groups disperse your compute instances across physical machines (hosts) in one of our compute regions. Depending on your workload requirements, you may need your compute instances to follow specific strategies:\n\n- __Grouped together__. You may want them placed close together to reduce latency between compute instances that are used for an application or workload.\n- __Spread apart__. You may want to disperse them across several hosts to support high availability, for example when required for failover.\n\n<>\n\n> \ud83d\udcd8\n>\n> - For this request to complete successfully, your user needs to have the `add_placement` grant.\n> - We offer an [example API workflow](https://www.linode.com/docs/products/compute/compute-instances/guides/placement-groups/#create-a-placement-group) you can follow to create a placement group.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli placement group-create \\\n --label PG_Miami_failover \\\n --region us-mia \\\n --placement_group_type \"anti-affinity:local\" \\\n --placement_group_policy strict\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n linodes:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-placement-group" @@ -96903,7 +96905,7 @@ "type": "string" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled:\n\n- `strict`. Don't add a compute instance if it breaks the grouped-together or spread-apart model set by your `placement_group_type`. For example, with `anti-affinity:local` as your `placement_group_type`, assume it already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, an error is thrown and the system won't add it. Ensures the placement group stays compliant with your selected model.\n- `flexible`. Add a new compute instance, even if it breaks the grouped-together or spread-apart model set by your `placement_group_type`. Breaking the model makes the placement group non-compliant. You need to wait for Akamai to move the offending compute instances to make the group compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n> 📘\n>\n> Once you create a placement group, you can't change its `placement_group_policy` setting.", + "description": "How requests to add future compute instances to your placement group are handled:\n\n- `strict`. Don't add a compute instance if it breaks the grouped-together or spread-apart model set by your `placement_group_type`. For example, with `anti-affinity:local` as your `placement_group_type`, assume it already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, an error is thrown and the system won't add it. Ensures the placement group stays compliant with your selected model.\n- `flexible`. Add a new compute instance, even if it breaks the grouped-together or spread-apart model set by your `placement_group_type`. Breaking the model makes the placement group non-compliant. You need to wait for Akamai to move the offending compute instances to make the group compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n> \ud83d\udcd8\n>\n> Once you create a placement group, you can't change its `placement_group_policy` setting.", "enum": [ "strict", "flexible" @@ -96912,7 +96914,7 @@ "type": "string" }, "placement_group_type": { - "description": "How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -96974,7 +96976,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -97014,7 +97016,7 @@ "type": "array" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -97023,7 +97025,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -97193,7 +97195,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -97273,7 +97275,7 @@ "type": "object" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -97282,7 +97284,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -97467,7 +97469,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -97547,7 +97549,7 @@ "type": "object" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -97556,7 +97558,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -97677,7 +97679,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -97717,7 +97719,7 @@ "type": "array" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -97726,7 +97728,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -98023,7 +98025,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -98063,7 +98065,7 @@ "type": "array" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -98072,7 +98074,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -98272,7 +98274,7 @@ "x-linode-cli-display": 1 }, "is_compliant": { - "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> 📘\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", + "description": "Whether all of the compute instances in your placement group are compliant. If `true`, all compute instances meet either the grouped-together or spread-apart model, which you determine through your selected `placement_group_type`. If `false`, a compute instance is out of this compliance. For example, assume you've set `anti-affinity:local` as your `placement_group_type` and your group already has three qualifying compute instances on separate hosts, to support the spread-apart model. If a fourth compute instance is assigned that's on the same host as one of the existing three, the placement group is non-compliant. Enforce compliance in your group by setting a `placement_group_policy`.\n\n> \ud83d\udcd8\n>\n> Fixing compliance is not self-service. You need to wait for our assistance to physically move compute instances to make the group compliant again.", "example": true, "nullable": false, "type": "boolean" @@ -98312,7 +98314,7 @@ "type": "array" }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -98321,7 +98323,7 @@ "type": "string" }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -98471,7 +98473,7 @@ }, "/{apiVersion}/profile": { "get": { - "description": "Returns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth application.\n\n> 📘\n>\n> A third-party OAuth application accessing a profile with this operation has full access to all aspects of that profile.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli profile view\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", + "description": "Returns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth application.\n\n> \ud83d\udcd8\n>\n> A third-party OAuth application accessing a profile with this operation has full access to all aspects of that profile.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli profile view\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-profile" @@ -99700,7 +99702,7 @@ }, "last_remote_addr": { "description": "__Read-only__ The last IP Address to successfully authenticate with this TrustedDevice.", - "example": "192.0.2.134", + "example": "203.0.113.1", "readOnly": true, "type": "string" }, @@ -99886,7 +99888,7 @@ }, "last_remote_addr": { "description": "__Read-only__ The last IP Address to successfully authenticate with this TrustedDevice.", - "example": "192.0.2.91", + "example": "203.0.113.1", "readOnly": true, "type": "string" }, @@ -101660,7 +101662,7 @@ }, "/{apiVersion}/profile/security-questions": { "post": { - "description": "Adds security question responses for your user. You need to use exactly three unique questions. Previous responses are overwritten if answered, or they're reset to `null` if unanswered.\n\n> 📘\n>\n> You need to answer these security questions before you can access the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Adds security question responses for your user. You need to use exactly three unique questions. Previous responses are overwritten if answered, or they're reset to `null` if unanswered.\n\n> \ud83d\udcd8\n>\n> You need to answer these security questions before you can access the [Create a two factor secret](https://techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation.\n\n\n<>\n\n---\n\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/post-security-questions" @@ -102658,7 +102660,7 @@ "x-linode-cli-action": "update" }, "delete": { - "description": "Deletes an SSH Key you have access to.\n\n> 📘\n>\n> This operation only deletes a key's association from your profile. It doesn't remove it from any Linode or disk that was deployed with `authorized_keys`. You need to manually delete the key on the Linode or disk.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli sshkeys delete 42\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Deletes an SSH Key you have access to.\n\n> \ud83d\udcd8\n>\n> This operation only deletes a key's association from your profile. It doesn't remove it from any Linode or disk that was deployed with `authorized_keys`. You need to manually delete the key on the Linode or disk.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli sshkeys delete 42\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n account:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-ssh-key" @@ -104375,7 +104377,7 @@ }, "/{apiVersion}/regions/availability": { "get": { - "description": "Returns availability data for all Regions.\n\nCurrently, this operation returns availability of select premium and GPU plans for select regions.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli regions list-avail\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", + "description": "Returns availability data for all regions.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli regions list-avail\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-regions-availability" @@ -105039,7 +105041,7 @@ "type": "integer" }, "region": { - "description": "The ID of the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) where this ticket's target entity resides. This only applies to tickets for a `vlan` or an Object Storage `bucket`.\n\n> 📘\n>\n> Set this to the `clusterId` for a legacy Object Storage `bucket`.", + "description": "The ID of the [region](https://techdocs.akamai.com/linode-api/reference/get-regions) where this ticket's target entity resides. This only applies to tickets for a `vlan` or an Object Storage `bucket`.\n\n> \ud83d\udcd8\n>\n> Set this to the `clusterId` for a legacy Object Storage `bucket`.", "example": "{{region}}", "nullable": true, "type": "string" @@ -107302,7 +107304,7 @@ "ipv4": { "description": "__Filterable__, __Read-only__ 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](https://techdocs.akamai.com/linode-api/reference/post-ticket) to get additional IPv4 addresses.\n\nIPv4 addresses may be reassigned between your Linodes, or shared with other Linodes. See the [networking](https://techdocs.akamai.com/linode-api/reference/post-firewalls) operations for details.", "example": [ - "192.0.2.148", + "203.0.113.1", "192.0.2.1" ], "format": "ipv4", @@ -107321,7 +107323,7 @@ }, "ipv6": { "description": "__Read-only__ This Linode's IPv6 SLAAC address. This address is specific to a Linode, and may not be shared. If the Linode has not been assigned an IPv6 address, the return value will be `null`.", - "example": "2001:db8:3781:ad92:bf12:e807:fc6a:7a11/32", + "example": "c001:d00d::1337/128", "format": "ipv6/128", "nullable": true, "readOnly": true, @@ -107375,7 +107377,7 @@ "x-linode-filterable": true }, "placement_group_policy": { - "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> 📘\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", + "description": "How requests to add future compute instances to your placement group are handled, and whether it remains compliant:\n\n- `strict`. Don't assign a new compute instance if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. Use this to ensure the placement group stays compliant (`is_compliant: true`).\n- `flexible`. Assign a new compute instance, even if it breaks the grouped-together or spread-apart model set by the `placement_group_type`. This makes the group non-compliant (`is_compliant: false`). You need to wait for Akamai to move the offending compute instance to make it compliant again, once the necessary capacity is available in the region. Offers flexibility to add future compute instances if compliance isn't an immediate concern.\n\n<>\n\n> \ud83d\udcd8\n>\n> In rare cases, non-compliance can occur with a `strict` placement group if Akamai needs to failover or migrate your compute instances for maintenance. Fixing non-compliance for a `strict` placement group is prioritized over a `flexible` group.", "enum": [ "strict", "flexible" @@ -107385,7 +107387,7 @@ "x-linode-cli-display": null }, "placement_group_type": { - "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> 📘\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", + "description": "__Filterable__, __Read-only__ How compute instances are distributed in your placement group. A `placement_group_type` using anti-affinity (`anti-affinity:local`) places compute instances in separate hosts, but still in the same region. This best supports the spread-apart model for high availability. A `placement_group_type` using affinity places compute instances physically close together, possibly on the same host. This supports the grouped-together model for low-latency.\n\n> \ud83d\udcd8\n>\n> Currently, only `anti_affinity:local` is available for `placement_group_type`.", "enum": [ "anti_affinity:local" ], @@ -107533,7 +107535,7 @@ "description": "A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.", "properties": { "axfr_ips": { - "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> 📘\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", + "description": "The list of IPs that may perform a zone transfer for this domain. The total combined length of all data within this array cannot exceed 1000 characters.\n\n> \ud83d\udcd8\n>\n> This is potentially dangerous, and should be set to an empty list unless you intend to use it.", "example": [], "items": { "format": "ip", @@ -107855,7 +107857,7 @@ }, "ipv4": { "description": "__Filterable__, __Read-only__ This NodeBalancer's public IPv4 address.", - "example": "192.0.2.223", + "example": "203.0.113.1", "format": "ip", "readOnly": true, "type": "string", @@ -111104,7 +111106,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.149/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -111317,7 +111319,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.98/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -111706,7 +111708,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.114/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -111912,7 +111914,7 @@ }, "/{apiVersion}/vpcs/ips": { "get": { - "description": "Returns a paginated list of all VPC IP addresses and address ranges on your account.\n\n> 📘\n>\n> If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vpcs ips-all-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Returns a paginated list of all VPC IP addresses and address ranges on your account.\n\n> \ud83d\udcd8\n>\n> If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vpcs ips-all-list\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n ips:read_only\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips" @@ -112084,7 +112086,7 @@ }, "nat_1_1": { "description": "__Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used.", - "example": "192.0.2.177", + "example": "192.168.0.42", "format": "ip", "readOnly": true, "type": "string" @@ -112118,7 +112120,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`.", - "example": "192.0.2.108", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -112367,7 +112369,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.222/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -112689,7 +112691,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.23/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -113179,7 +113181,7 @@ }, "nat_1_1": { "description": "__Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used.", - "example": "192.0.2.39", + "example": "192.168.0.42", "format": "ip", "readOnly": true, "type": "string" @@ -113213,7 +113215,7 @@ }, "subnet_mask": { "description": "__Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`.", - "example": "192.0.2.63", + "example": "255.255.255.0", "format": "ip", "readOnly": true, "type": "string" @@ -113455,7 +113457,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.86/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -113746,7 +113748,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.9/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -113986,7 +113988,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.90/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -114212,7 +114214,7 @@ }, "ipv4": { "description": "IPv4 range in CIDR canonical form.\n\n- The range must belong to a private address space as defined in [RFC1918](https://datatracker.ietf.org/doc/html/rfc1918).\n- Allowed prefix lengths: 1-29.\n- The range must not overlap with 192.168.128.0/17.\n- The range must not overlap with other Subnets on the same VPC.", - "example": "192.0.2.194/24", + "example": "10.0.1.0/24", "format": "ip", "type": "string", "x-linode-cli-display": 3 @@ -114369,7 +114371,7 @@ "x-linode-grant": "read_write" }, "delete": { - "description": "Delete a single VPC Subnet.\n\nThe user accessing this operation must have `read_write` grants to the VPC. A successful request triggers a `subnet_delete` event.\n\n> 📘\n>\n> You need to delete all the Configuration Profile Interfaces that this subnet is assigned to before you can delete it. If those interfaces are active, the associated Linode needs to be shut down before they can be removed.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vpcs subnet-delete $vpcId $vpcSubnetId\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n vpc:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", + "description": "Delete a single VPC Subnet.\n\nThe user accessing this operation must have `read_write` grants to the VPC. A successful request triggers a `subnet_delete` event.\n\n> \ud83d\udcd8\n>\n> You need to delete all the Configuration Profile Interfaces that this subnet is assigned to before you can delete it. If those interfaces are active, the associated Linode needs to be shut down before they can be removed.\n\n\n<>\n\n---\n\n\n- __CLI__.\n\n ```\n linode-cli vpcs subnet-delete $vpcId $vpcSubnetId\n ```\n\n [Learn more...](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)\n\n- __OAuth scopes__.\n\n ```\n vpc:read_write\n ```\n\n [Learn more...](https://techdocs.akamai.com/linode-api/reference/get-started#oauth)", "externalDocs": { "description": "See documentation for this operation in Akamai's Linode API", "url": "https://techdocs.akamai.com/linode-api/reference/delete-vpc-subnet"