diff --git a/_vendor/github.com/linode/linode-api-docs/v4/openapi.yaml b/_vendor/github.com/linode/linode-api-docs/v4/openapi.yaml index 3e0820f8f04..8eddb1d7abd 100644 --- a/_vendor/github.com/linode/linode-api-docs/v4/openapi.yaml +++ b/_vendor/github.com/linode/linode-api-docs/v4/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - version: 4.170.2 + version: 4.171.0 title: Linode API license: name: Apache 2.0 @@ -84,7 +84,7 @@ info: | 1. The user visits the application's website and is directed to login with Linode. | 1. The user visits the application's website and is directed to login with Linode. | | 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. | 2. Your application then redirects the user to Linode's [login server](https://login.linode.com) with the client application's `client_id` and requested OAuth `scope`, which should appear in the URL of the login page. | | 3. The user logs into the login server with their username and password. | 3. The user logs into the login server with their username and password. | - | 4. The login server redirects the user to the specificed redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The login server redirects the user back to your application with an OAuth `access_token` embedded in the redirect URL's hash. This is temporary and expires in two hours. No `refresh_token` is issued. Therefore, once the `access_token` expires, a new one will need to be issued by having the user log in again. | + | 4. The login server redirects the user to the specified redirect URL with a temporary authorization `code` (exchange code) in the URL. | 4. The login server redirects the user back to your application with an OAuth `access_token` embedded in the redirect URL's hash. This is temporary and expires in two hours. No `refresh_token` is issued. Therefore, once the `access_token` expires, a new one will need to be issued by having the user log in again. | | 5. The application issues a POST request (*see additional details below*) to the login server with the exchange code, `client_id`, and the client application's `client_secret`. | | | 6. The login server responds to the client application with a new OAuth `access_token` and `refresh_token`. The `access_token` is set to expire in two hours. | | | 7. The `refresh_token` can be used by contacting the login server with the `client_id`, `client_secret`, `grant_type`, and `refresh_token` to get a new OAuth `access_token` and `refresh_token`. The new `access_token` is good for another two hours, and the new `refresh_token` can be used to extend the session again by this same method (*see additional details below*). | | @@ -224,7 +224,7 @@ info: your request. If this occurs, please [open a Support Ticket](/docs/api/support/#support-ticket-open) and let us know. Though errors are logged and we work quickly to resolve issues, - opening a ticket and providing us with reproducable steps and data is always helpful. + opening a ticket and providing us with reproducible steps and data is always helpful. The `errors` field is an array of the things that went wrong with your request. We will try to include as many of the problems in the response as possible, @@ -5165,7 +5165,7 @@ paths: Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance. - Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type. + Each Managed Database can have one node type. In the case of a high availability Database, all nodes are provisioned according to the chosen type. responses: '200': description: Returns a paginated list of all Managed Database types. @@ -7218,9 +7218,15 @@ paths: Linodes utilizing Metadata (`"has_user_data": true`) must be cloned to a new Linode with `metadata.user_data` included with the clone request. - **Note:** Only Next Generation Network (NGN) data centers support VLANs. If a VLAN is attached to your Linode and you attempt clone it to a non-NGN data center, the cloning will not initiate. If a Linode cannot be cloned because of an incompatibility, you will be prompted to select a different data center or contact support. + `vpc` details - **VPC BETA:** If the Linode you are cloning has a `vpc` purpose Interface on its active Configuration Profile that includes a 1:1 NAT, the resulting clone is configured with an `any` 1:1 NAT. + - If the Linode you are cloning has a `vpc` purpose Interface on its active Configuration Profile that includes a 1:1 NAT, the resulting clone is configured with an `any` 1:1 NAT. + - See the [VPC documentation](/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. + + `vlan` details + + - Only Next Generation Network (NGN) data centers support VLANs. If a VLAN is attached to your Linode and you attempt clone it to a non-NGN data center, the cloning will not initiate. If a Linode cannot be cloned because of an incompatibility, you will be prompted to select a different data center or contact support. + - See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. tags: - Linode Instances operationId: cloneLinodeInstance @@ -7692,11 +7698,9 @@ paths: - Linode Instances x-linode-grant: read_only servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 summary: Configuration Profile Interfaces List description: | - **VPC BETA ONLY** - Returns an ordered array of all Interfaces associated with this Configuration Profile. * The User accessing this command must have at least `read_only` grants to the Linode. operationId: getLinodeConfigInterfaces @@ -7719,7 +7723,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId/interfaces \ + curl https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -7728,10 +7732,8 @@ paths: x-linode-grant: read_write summary: Configuration Profile Interface Add servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Creates and appends a single Interface to the end of the `interfaces` array for an existing Configuration Profile. * The User accessing this command must have `read_write` grants to the Linode. * A successful request triggers a `linode_config_update` event. @@ -7768,7 +7770,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId \ + curl https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X POST -d '{ @@ -7804,10 +7806,8 @@ paths: delete: summary: Configuration Profile Interface Delete servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Deletes an Interface from the Configuration Profile. * The User accessing this command must have `read_write` grants to the Linode. @@ -7836,7 +7836,7 @@ paths: source: > curl -H "Authorization: Bearer $TOKEN" \ -X DELETE \ - https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId + https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId - lang: CLI source: > linode-cli linodes config-delete $linodeId $configId $interfaceId @@ -7845,11 +7845,9 @@ paths: - Linode Instances x-linode-grant: read_only servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 summary: Configuration Profile Interface View description: | - **VPC BETA ONLY** - Returns a single Configuration Profile Interface. * The User accessing this command must have at least `read_only` grants to the Linode. operationId: getLinodeConfigInterface @@ -7871,7 +7869,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId \ + curl https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -7880,10 +7878,8 @@ paths: x-linode-grant: read_write summary: Configuration Profile Interface Update servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Updates a `vpc` or `public` purpose Interface for this Configuration Profile. * The User accessing this command must have `read_write` grants to the Linode. * A successful request triggers a `linode_config_update` event. @@ -7912,10 +7908,10 @@ paths: $ref: '#/components/schemas/LinodeConfigInterface/properties/primary' ipv4: $ref: '#/components/schemas/LinodeConfigInterface/properties/ipv4' + ip_ranges: + $ref: '#/components/schemas/LinodeConfigInterface/properties/ip_ranges' # ipv6: # $ref: '#/components/schemas/LinodeConfigInterface/properties/ipv6' - # ip_ranges: - # $ref: '#/components/schemas/LinodeConfigInterface/properties/ip_ranges' responses: '200': description: Interface successfully updated. @@ -7928,7 +7924,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId \ + curl https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces/$interfaceId \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X PUT -d '{ @@ -7953,10 +7949,8 @@ paths: x-linode-grant: read_write summary: Configuration Profile Interfaces Order servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Reorders the existing Interfaces of a Configuration Profile. * The User accessing this command must have `read_write` grants to the Linode. tags: @@ -8006,7 +8000,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/linode/instances/$linodeId/configs/$configId/interfaces/order \ + curl https://api.linode.com/v4/linode/instances/$linodeId/configs/$configId/interfaces/order \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X POST -d '{ @@ -8904,21 +8898,23 @@ paths: When the migration begins, your Linode will be shutdown if not already off. If the migration initiated the shutdown, it will reboot the Linode when completed. - To initiate a cross DC migration, you must pass a `region` parameter to the - request body specifying the target data center region. - You can view a list of all available regions and their feature capabilities - from [GET /regions](/docs/api/regions/#regions-list). See our [Pricing Page](https://www.linode.com/pricing/) for Region-specific pricing, which applies after migration is complete. If your Linode has a DC migration already queued - or you have initiated a previously scheduled migration, you will not be able to initiate + To initiate a cross DC migration, you must pass a `region` parameter to the request body specifying the target data center region. You can view a list of all available regions and their feature capabilities + from [GET /regions](/docs/api/regions/#regions-list). See our [Pricing Page](https://www.linode.com/pricing/) for Region-specific pricing, which applies after migration is complete. If your Linode has a DC migration already queued or you have initiated a previously scheduled migration, you will not be able to initiate a DC migration until it has completed. - **Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. + `vpc` details + + - Cross DC migrations are not allowed for Linodes that have a `vpc` purpose Configuration Profile Interface. Host migrations within the same DC are permitted. + - See the [VPC documentation](/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. + + `vlan` details + + - Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint 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. + - Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover. If you have these features enabled on your Linode and attempt to migrate to an NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support. - - **Note:** Only Next Generation Network (NGN) data centers support VLANs. If a VLAN is attached to your Linode and you attempt to migrate it to a non-NGN data center, the migration will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support. - - **VPC BETA:** Cross DC migrations are not allowed for Linodes that have a `vpc` purpose Configuration Profile Interface. Host migrations within the same DC are permitted. + - See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. tags: - Linode Instances operationId: migrateLinodeInstance @@ -13228,8 +13224,7 @@ paths: * **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view)) * **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update)) - **VPC BETA ONLY** - * Addresses with an active 1:1 NAT to a VPC Interface address cannot be assigned to other Linodes. + **Note:** Addresses with an active 1:1 NAT to a VPC Interface address cannot be assigned to other Linodes. operationId: assignIPs x-linode-cli-action: ip-assign security: @@ -13285,7 +13280,7 @@ paths: x-linode-cli-command: networking post: servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 x-linode-grant: read_write tags: - Networking @@ -13297,7 +13292,7 @@ paths: IP failover requires configuration of a failover service (such as [Keepalived](/docs/guides/ip-failover-keepalived)) within the internal system of the primary Linode. - **VPC BETA:** A public IPv4 address cannot be shared if it is configured for a 1:1 NAT on a `vpc` purpose Configuration Profile Interface. + **Note:** A public IPv4 address cannot be shared if it is configured for a 1:1 NAT on a `vpc` purpose Configuration Profile Interface. operationId: shareIPs x-linode-cli-action: ip-share security: @@ -14510,7 +14505,7 @@ paths: get: x-linode-grant: read_only servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' @@ -14534,10 +14529,7 @@ paths: - [Create](/docs/api/linode-instances/#configuration-profile-create) a new Configuration Profile without the VLAN Interface, then [reboot](/docs/api/linode-instances/#linode-reboot) the Linode into the new Configuration Profile. - [Delete](/docs/api/linode-instances/#linode-delete) the Linode. - **Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint 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 because of an incompatibility, - you will be prompted to select a different data center or contact support. + **Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint 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 because of an incompatibility, you will be prompted to select a different data center or contact support. **Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations. operationId: getVLANs @@ -14572,7 +14564,7 @@ paths: - lang: Shell source: > curl -H "Authorization: Bearer $TOKEN" \ - https://api.linode.com/v4beta/networking/vlans/ + https://api.linode.com/v4/networking/vlans/ - lang: CLI source: > linode-cli vlans list @@ -19646,11 +19638,9 @@ paths: - VPCs summary: VPCs List servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - - Display all VPCs belonging to your Account. + Display all VPCs on your account. operationId: getVPCs x-linode-cli-action: - list @@ -19676,7 +19666,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs \ + curl https://api.linode.com/v4/vpcs \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -19687,10 +19677,8 @@ paths: - VPCs summary: VPC Create servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Create a new VPC and optionally associated VPC Subnets. * Users must have the `add_vpc` grant to access this command. * A successful request triggers a `vpc_create` event and `subnet_create` events for any created VPC Subnets. @@ -19735,7 +19723,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs \ + curl https://api.linode.com/v4/vpcs \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X POST -d '{ @@ -19765,10 +19753,8 @@ paths: x-linode-grant: read_write summary: VPC Delete servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Delete a single VPC and all of its Subnets. * The User accessing this command must have `read_write` grants to the VPC. * A successful request triggers a `vpc_delete` event and `subnet_delete` events for each deleted VPC Subnet. @@ -19793,7 +19779,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId \ + curl https://api.linode.com/v4/vpcs/$vpcId \ -H "Authorization: Bearer $TOKEN" \ -X DELETE - lang: CLI @@ -19802,10 +19788,8 @@ paths: get: summary: VPC View servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Get information about a single VPC. tags: - VPCs @@ -19826,7 +19810,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId \ + curl https://api.linode.com/v4/vpcs/$vpcId \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -19837,11 +19821,9 @@ paths: - VPCs summary: VPC Update servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - - Update a VPC. + Update an existing VPC. * The User accessing this command must have `read_write` grants to the VPC. * A successful request triggers a `vpc_update` event. @@ -19878,7 +19860,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId \ + curl https://api.linode.com/v4/vpcs/$vpcId \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X PUT -d '{ @@ -19899,13 +19881,11 @@ paths: - VPCs summary: VPC Subnets List servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 parameters: - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageSize' description: | - **VPC BETA ONLY** - Get information about all VPC Subnets associated with a VPC. operationId: getVPCSubnets x-linode-cli-action: @@ -19932,7 +19912,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId/subnets \ + curl https://api.linode.com/v4/vpcs/$vpcId/subnets \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -19943,10 +19923,8 @@ paths: - VPCs summary: VPC Subnet Create servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Create a VPC Subnet. * The User accessing this command must have `read_write` grants to the VPC. * A successful request triggers a `subnet_create` event. @@ -19993,7 +19971,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId/subnets \ + curl https://api.linode.com/v4/vpcs/$vpcId/subnets \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X POST -d '{ @@ -20014,17 +19992,13 @@ paths: x-linode-grant: read_write summary: VPC Subnet Delete servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Delete a single VPC Subnet. - The User accessing this command must have `read_write` grants to the VPC. + The user accessing this command must have `read_write` grants to the VPC. A successful request triggers a `subnet_delete` event. - A successful request triggers a `subnet_delete` event. - - * All Configuration Profile Interfaces that this Subnet is assigned to must first be deleted. If those Interfaces are active, the associated Linode must first be shut down before they can be removed. + **Note:** 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. tags: - VPCs operationId: deleteVPCSubnet @@ -20045,7 +20019,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId/subnets/$vpcSubnetId \ + curl https://api.linode.com/v4/vpcs/$vpcId/subnets/$vpcSubnetId \ -H "Authorization: Bearer $TOKEN" \ -X DELETE - lang: CLI @@ -20054,10 +20028,8 @@ paths: get: summary: VPC Subnet View servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Get information about a single VPC Subnet. tags: - VPCs @@ -20078,7 +20050,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId/subnets/$vpcSubnetId \ + curl https://api.linode.com/v4/vpcs/$vpcId/subnets/$vpcSubnetId \ -H "Authorization: Bearer $TOKEN" - lang: CLI source: > @@ -20089,10 +20061,8 @@ paths: - VPCs summary: VPC Subnet Update servers: - - url: https://api.linode.com/v4beta + - url: https://api.linode.com/v4 description: | - **VPC BETA ONLY** - Update a VPC Subnet. * The User accessing this command must have `read_write` grants to the VPC. * A successful request triggers a `subnet_update` event. @@ -20126,7 +20096,7 @@ paths: x-code-samples: - lang: Shell source: > - curl https://api.linode.com/v4beta/vpcs/$vpcId/subnets/$vpcSubnetId \ + curl https://api.linode.com/v4/vpcs/$vpcId/subnets/$vpcSubnetId \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -X PUT -d '{ @@ -20483,7 +20453,7 @@ components: description: | The zip code of this Account's billing address. The following restrictions apply: - - May only consist of letters, numbers, spaces, and hyphens. + - Can only contain ASCII letters, numbers, and hyphens (`-`). - Must not contain more than 9 letter or number characters. example: 19102-1234 AccountAvailability: @@ -20498,11 +20468,15 @@ components: example: us-east x-linode-cli-display: 1 unavailable: - type: list + type: array readOnly: true description: > A list of strings of unavailable services. - example: ["Linodes", "Block Storage"] + example: + - "Linodes" + - "Block Storage" + items: + type: string x-linode-cli-display: 2 AccountSettings: type: object @@ -20640,8 +20614,7 @@ components: - snapshot readOnly: true description: > - This indicates whether the Backup is an automatic Backup or - manual snapshot taken by the User at a specific point in time. + This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. example: snapshot x-linode-cli-display: 3 status: @@ -20818,7 +20791,7 @@ components: properties: card_number: type: string - description: Your credit card number. No spaces or dashes allowed. + description: Your credit card number. No spaces or hyphens (`-`) allowed. minLength: 14 maxLength: 24 format: digits @@ -21088,7 +21061,7 @@ components: description: | The label for the Database snapshot backup. - * Must include only ASCII letters, numbers, or underscores. + * Can only contain ASCII letters, numbers, and underscores (`_`). * Must be unique among other backup labels for this Database. example: db-snapshot target: @@ -22515,8 +22488,8 @@ components: Firewall labels have the following constraints: * Must begin and end with an alphanumeric character. - * May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`). - * Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row. + * May only consist of alphanumeric characters, hyphens (`-`), underscores (`_`) or periods (`.`). + * Cannot have two hyphens (`--`), underscores (`__`) or periods (`..`) in a row. * Must be between 3 and 32 characters. * Must be unique. example: firewall123 @@ -23261,32 +23234,26 @@ components: vpc_nat_1_1: type: object description: | - **VPC BETA ONLY** - IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. - Only allowed for `vpc` type Interfaces. + **Note:** Only allowed for `vpc` type Interfaces. properties: vpc_id: type: integer readOnly: true - nullable: true + nullable: false description: | - **VPC BETA ONLY** - The `id` of the VPC configured for this Interface. example: 111 subnet_id: type: integer - nullable: true + nullable: false description: | - **VPC BETA ONLY** - The `id` of the VPC Subnet for this Interface. example: 101 address: type: string - format: ipv4|ipv6/prefix_length + format: ipv4 description: | The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.0.2.1 @@ -23426,6 +23393,32 @@ components: readOnly: true x-linode-filterable: true x-linode-cli-display: 5 + vpc_nat_1_1: + type: object + 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. + + **Note:** Only allowed for `vpc` type Interfaces. + properties: + vpc_id: + type: integer + readOnly: true + nullable: false + description: | + The `id` of the VPC configured for this Interface. + example: 111 + subnet_id: + type: integer + nullable: false + description: | + The `id` of the VPC Subnet for this Interface. + example: 101 + address: + type: string + format: ipv4 + description: | + The IPv4 address that is configured as a 1:1 NAT for this VPC interface. + example: 192.0.2.1 IPAddressesShareRequest: type: object description: A request object IP Addresses Share (POST /networking/ips/share) @@ -23829,8 +23822,8 @@ components: Linode labels have the following constraints: * Must begin and end with an alphanumeric character. - * May only consist of alphanumeric characters, dashes (`-`), underscores (`_`) or periods (`.`). - * Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row. + * May only consist of alphanumeric characters, hyphens (`-`), underscores (`_`) or periods (`.`). + * Cannot have two hyphens (`--`), underscores (`__`) or periods (`..`) in a row. example: linode123 minLength: 3 maxLength: 64 @@ -24289,15 +24282,13 @@ components: For `vlan` purpose Interfaces: * Required. * Must be unique among the Linode's Interfaces (a Linode cannot be attached to the same VLAN multiple times). - * May only consist of ASCII letters, numbers, and dashes (`-`). + * Can only contain ASCII letters, numbers, and hyphens (`-`). You can't use two consecutive hyphens (`--`). * If the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, use the [VLANs List](/docs/api/networking/#vlans-list) endpoint. For `public` purpose Interfaces: * In requests, must be an empty string (`""`) or `null` if included. * In responses, always returns `null`. - **VPC BETA ONLY** - For `vpc` purpose Interfaces: * In requests, must be an empty string (`""`) or `null` if included. * In responses, always returns `null`. @@ -24319,8 +24310,6 @@ components: * In requests, must be an empty string (`""`) or `null` if included. * In responses, always returns `null`. - **VPC BETA ONLY** - For `vpc` purpose Interfaces: * In requests, must be an empty string (`""`) or `null` if included. * In responses, always returns `null`. @@ -24344,8 +24333,6 @@ components: * Configuring a `vlan` purpose Interface attaches this Linode to the VLAN with the specified `label`. * The Linode is configured to use the specified `ipam_address`, if any. - **VPC BETA ONLY** - * `vpc` * Configuring a `vpc` purpose Interface attaches this Linode to the existing VPC Subnet with the specified `subnet_id`. * When the Interface is activated, the Linode is configured to use an IP address from the range in the assigned VPC Subnet. See `ipv4.vpc` for more information. @@ -24354,15 +24341,11 @@ components: active: type: boolean description: | - **VPC BETA ONLY** - Returns `true` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. Otherwise returns `false`. example: true primary: type: boolean description: | - **VPC BETA ONLY** - The primary Interface is configured as the default route to the Linode. Each Configuration Profile can have up to one `"primary": true` Interface at a time. @@ -24376,41 +24359,30 @@ components: readOnly: true nullable: true description: | - **VPC BETA ONLY** - - The `id` of the VPC configured for this Interface. - * `null` for non-`vpc` type Interfaces. + The `id` of the VPC configured for this Interface. Returns `null` for non-`vpc` type Interfaces. example: 111 subnet_id: type: integer nullable: true description: | - **VPC BETA ONLY** - The `id` of the VPC Subnet for this Interface. In requests, this value is used to assign a Linode to a VPC Subnet. * Required for `vpc` type Interfaces. - * `null` for non-`vpc` type Interfaces. + * Returns `null` for non-`vpc` type Interfaces. * Once a VPC Subnet is assigned to an Interface, it cannot be updated. * The Linode must be rebooted with the Interface's Configuration Profile to complete assignment to a VPC Subnet. example: 101 ipv4: type: object description: | - **VPC BETA ONLY** - - IPv4 addresses configured for this Interface. - - Only allowed for `vpc` type Interfaces. + IPv4 addresses configured for this Interface. Only allowed for `vpc` type Interfaces. Returns `null` if no `vpc` Interface is assigned. properties: vpc: type: string format: ip nullable: true description: | - **VPC BETA ONLY** - The VPC Subnet IPv4 address for this Interface. * Only allowed for `vpc` type Interfaces. @@ -24426,24 +24398,23 @@ components: format: ip nullable: true description: | - **VPC BETA ONLY** - The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. * Only allowed for `vpc` type Interfaces. + * Returns `null` if no 1:1 NAT is set for a `vpc` type Interface. * Returns an empty string (`""`) for non-`vpc` type Interfaces. For requests: * Setting this value to `any` enables the Linode's assigned public IPv4 address on this Interface and establishes a 1:1 NAT between the public IPv4 and VPC Subnet IPv4 addresses. * Setting the value to a specific public IPv4 address that is assigned to the Linode enables a 1:1 NAT between that address and the VPC Subnet IPv4 address. - * The public IPv4 address must not be shared with another Linode. - * If ommitted, `null`, or an empty string (`""`), no 1:1 NAT is established. + * The public IPv4 address can't be shared with another Linode. + * If omitted, set to `null`, or set to an empty string (`""`), no 1:1 NAT is established. example: '203.0.113.2' # ipv6: # type: object # description: | # **VPC BETA ONLY** - + # # IPv6 addresses configured for this Interface. # properties: # vpc: @@ -24451,40 +24422,38 @@ components: # format: ip # description: | # **VPC BETA ONLY** - + # # The VPC IPv6 address assigned to this Interface. - + # # * Only allowed for `vpc` type Interfaces. # * Returns an empty string (`""`) for non-`vpc` type Interfaces. - + # # For requests: # * The VPC Subnet must have an IPv6 range. # * Must not already be actively assigned as an address or within a range. # * Must not be the first two or last two addresses in the Subnet IPv6 Range. # * If omitted, a valid address within the Subnet IPv6 range is automatically assigned. # example: 'fd04:495a:691c:971c::2' - # ip_ranges: - # type: array - # nullable: true - # description: | - # **VPC BETA ONLY** + ip_ranges: + type: array + nullable: true + description: | + An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. **IPv6 ranges are also available to select participants in the Beta program.** - # An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. **IPv6 ranges are also available to select participants in the Beta program.** - - # * Array items are only allowed for `vpc` type Interfaces. - # * This must be empty for non-`vpc` type Interfaces. - - # For requests: - # * Addresses in submitted ranges must not already be actively assigned. - # * Submitting values replaces any existing values. - # * Submitting an empty array removes any existing values. - # * Omitting this property results in no change to existing values. - # items: - # type: string - # format: ip - # example: - # - 10.0.0.64/26 - # - fd04:495a:691c:971c::1:0/112 + * Array items are only allowed for `vpc` type Interfaces. + * This must be empty for non-`vpc` type Interfaces. + + For requests: + * Addresses in submitted ranges must not already be actively assigned. + * Submitting values replaces any existing values. + * Submitting an empty array removes any existing values. + * Omitting this property results in no change to existing values. + items: + type: string + format: ip + example: + - 10.0.0.64/26 + - fd04:495a:691c:971c::1:0/112 LinodeConfigInterfaces: type: array items: @@ -24495,9 +24464,7 @@ components: required: - purpose 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: + 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: - First [0]: eth0 - Second [1]: eth1 @@ -24509,11 +24476,14 @@ components: **Note:** Changes to Linode Interface configurations can be enabled by rebooting the Linode. - **Note:** Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint 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. + `vpc` details + + See the [VPC documentation](/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. - **Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. + `vlan` details + + - Only Next Generation Network (NGN) data centers support VLANs. Use the Regions ([/regions](/docs/api/regions/)) endpoint 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. + - See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations. example: - { "id": 101, @@ -24523,10 +24493,7 @@ components: "primary": false, "vpc_id": null, "subnet_id": null, - "ipv4": { - "vpc": "", - "nat_1_1": "" - } + "ipv4": null } - { "id": 102, @@ -24537,8 +24504,8 @@ components: "vpc_id": null, "subnet_id": null, "ipv4": { - "vpc": "", - "nat_1_1": "" + "vpc": "10.0.0.2", + "nat_1_1": null } } - { @@ -28486,8 +28453,8 @@ components: description: | The VPC's label, for display purposes only. - * Must be unique among the Account's VPCs. - * Must contain only ASCII letters, numbers, and hyphens (`-`). + * Needs to be unique among the Account's VPCs. + * Can only contain ASCII letters, numbers, and hyphens (`-`). You can't use two consecutive hyphens (`--`). example: cool-vpc x-linode-cli-display: 2 description: @@ -28543,7 +28510,7 @@ components: The VPC Subnet's label, for display purposes only. * Must be unique among the VPC's Subnets. - * Must contain only ASCII letters, numbers, and hyphens (`-`). + * Can only contain ASCII letters, numbers, and hyphens (`-`). You can't use two consecutive hyphens (`--`). example: cool-vpc-subnet x-linode-cli-display: 2 ipv4: diff --git a/_vendor/modules.txt b/_vendor/modules.txt index d42c0962329..18df5643869 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -5,4 +5,4 @@ # github.com/bep/turbo/v7 v7.20300.20000 # github.com/gohugoio/hugo-mod-jslibs/instantpage v0.5.1 # github.com/instantpage/instant.page v5.1.1+incompatible -# github.com/linode/linode-api-docs/v4 v4.170.2 +# github.com/linode/linode-api-docs/v4 v4.171.0 diff --git a/go.mod b/go.mod index bed55d13514..ffe88477e29 100644 --- a/go.mod +++ b/go.mod @@ -4,6 +4,6 @@ go 1.15 require ( github.com/hotwired/turbo v7.0.1+incompatible // indirect - github.com/linode/linode-api-docs/v4 v4.170.2 // indirect + github.com/linode/linode-api-docs/v4 v4.171.0 // indirect github.com/linode/linode-docs-theme v0.0.0-20231206150915-b245bac51c82 // indirect ) diff --git a/go.sum b/go.sum index bc2cfa8d80a..1a5440763b0 100644 --- a/go.sum +++ b/go.sum @@ -117,6 +117,8 @@ github.com/linode/linode-api-docs/v4 v4.170.0 h1:tec83RXRsvUrmhPO/hMqhHP6pQ1CdjK github.com/linode/linode-api-docs/v4 v4.170.0/go.mod h1:JRT7kOTjArLJngT4KkAnxWNGszYSP+zlQg2OHQ407RI= github.com/linode/linode-api-docs/v4 v4.170.2 h1:sinJqcS08nq2EZz0h/1J13zNZYJ3kt9NOUR0YSAkMEQ= github.com/linode/linode-api-docs/v4 v4.170.2/go.mod h1:JRT7kOTjArLJngT4KkAnxWNGszYSP+zlQg2OHQ407RI= +github.com/linode/linode-api-docs/v4 v4.171.0 h1:hEd02yYnRH+ZRokR+694+qU8XTaBD3BKJwaflzkLy18= +github.com/linode/linode-api-docs/v4 v4.171.0/go.mod h1:JRT7kOTjArLJngT4KkAnxWNGszYSP+zlQg2OHQ407RI= github.com/linode/linode-docs-theme v0.0.0-20220622135843-166f108e1933 h1:QchGQS6xESuyjdlNJEjvq2ftGX0sCTAhPhD5hAOJVMI= github.com/linode/linode-docs-theme v0.0.0-20220622135843-166f108e1933/go.mod h1:6kYeZt+rMvJFZ9Wbnm4CDSn8Sg1MuYjr2Kx6W/awiQM= github.com/linode/linode-docs-theme v0.0.0-20220718150422-ea48dbf69943 h1:BE3OgPTfmSdYeNUxcC1clIpJZhdMmYByCCCap0njwyY=