openapi: 3.2.0 info: contact: email: support@linode.com name: Linode url: https://linode.com description: Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: 'Akamai: Linode Configuration profile interfaces API' version: 4.215.0 servers: - url: https://api.linode.com tags: - description: Use these operations to upgrade and manage a legacy configuration profile on your Linode to include networking interfaces. name: Configuration profile interfaces paths: /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The `id` of the Linode. example: '{{linodeId}}' in: path name: linodeId required: true schema: example: 234 type: integer x-akamai: file-path: parameters/linode-id.yaml - description: The `id` of the Configuration Profile. example: '{{configId}}' in: path name: configId required: true schema: example: 521 type: integer x-akamai: file-path: parameters/config-id-profile.yaml x-akamai: file-path: paths/interfaces.yaml path-info: /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces x-linode-cli-command: linodes post: description: 'Creates and appends a single interface to the end of the `interfaces` array for an existing configuration profile. After you add the interface, you need to reboot the target Linode. - To access this operation, your user needs the `read_write` grant for the Linode. - A successful request triggers a `linode_config_update` event. - Only one interface can be set as `primary`. Setting `primary` to `true` for an interface sets all other interfaces to `false`. > --- - __CLI__. ``` linode-cli linodes config-interface-add $linodeId $configId \ --purpose vpc \ --primary false \ --subnet_id 101 \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" ``` Learn more... - __OAuth scopes__. ``` linodes:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interface operationId: post-linode-config-interface requestBody: content: application/json: schema: allOf: - required: - purpose - additionalProperties: false description: The network interface to apply to this Linode's configuration profile. properties: active: description: __Read-only__ Returns `true` if the interface is in use, meaning that the Linode has been booted using the configuration profile to which the interface belongs. example: true readOnly: true type: boolean id: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 ip_ranges: description: 'IPv4 CIDR VPC subnet ranges that are routed to this interface. When included in a request: - A range can''t include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Submit this as an empty array removes all existing values. - Omit this object to leave existing values as is. <> > 📘 > > This is only supported for interfaces with a `purpose` of `vpc`.' example: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: - array - 'null' ipam_address: description: 'This interface''s private IP address in classless inter-domain routing (CIDR) notation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vlan`: - To avoid conflicting addresses, make sure this value is unique for each `vlan` interface. - This should be unique among devices attached to the VLAN to avoid conflict. - If Network Helper is enabled, the Linode''s interface will be 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/). For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: 10.0.0.1/24 format: ip/netmask type: - string - 'null' x-linode-cli-display: 4 ipv4: additionalProperties: false description: IPv4 addresses configured for this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if no `vpc` interface is assigned. properties: nat_1_1: anyOf: - format: ip minLength: 1 title: An available public IPv4 address type: string - enum: - any title: The assigned public IPv4 address type: string description: 'The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface''s VPC subnet IPv4 address. - Only supported for interfaces with a `purpose` of `vpc`. - Returned as `null` if no 1:1 NAT is set for a `vpc` type interface. - Returned as an empty string (`""`) for non-`vpc` type interfaces. When included in a request: - 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. - A specified address can''t be shared with another Linode. - Omit this object or include it and set it to `null` or an empty string (`""`) to block creation of a 1:1 NAT. <> > 📘 > > 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 type: - string - 'null' 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 (`""`) for non-`vpc` type interfaces. When included in a request: - The `vpc` can''t be assigned to an existing Linode as an address or in a range. - The target address can''t be the first two or last two addresses in the subnet IPv4 range. - If omitted, a valid address within the Subnet IPv4 range is automatically assigned.' example: 10.0.0.2 format: ip type: - string - 'null' type: object label: description: '__Filterable__ The name of this interface. For interfaces with a `purpose` of `vlan`: - Required. - This needs to be unique among a Linode''s interfaces. A Linode can''t be attached to the same VLAN multiple times. - This can only contain ASCII letters, numbers, and dashes (`-`). You can''t use two consecutive dashes (`--`). - 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, run the [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans) operation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: example-interface maxLength: 64 minLength: 1 pattern: '[a-zA-Z0-9-]+' type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 2 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. > 📘 > > This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.' example: true type: boolean purpose: description: 'The type of interface. This can be `public`, `vlan`, or `vpc`. For interfaces with a `purpose` of `public`: - You can only define one `public` interface per Linode. - The Linode''s default public IPv4 address is assigned to the `public` interface. - A Linode needs a `public` interface in the first or `eth0` position to be reachable via the public internet, after it boots. If no `public` interface is configured, you can only access the Linode through [LISH](https://www.linode.com/docs/products/compute/compute-instances/guides/lish/), or through another Linode that''s connected to the same VLAN or VPC. For interfaces with a `purpose` of `vlan`: - Configuring this `purpose` of interface attaches a Linode to the VLAN with the specified `label`. - If an `ipam_address` is configured, the Linode uses this address. For interfaces with a `purpose` of `vpc`: - Configuring this `purpose` of interface attaches a Linode to an 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.' enum: - public - vlan - vpc example: vlan type: string x-linode-cli-display: 3 subnet_id: description: 'The `id` of the VPC subnet for this interface. Use this value in a request to assign a Linode to a VPC subnet. - Required for `vpc` type interfaces. - Returned as `null` for non-`vpc` type interfaces. - Once you''ve assigned a VPC subnet to an interface, you can''t update it. - You need to reboot a Linode using the interface''s configuration profile to assign the Linode to a VPC subnet.' example: 101 type: - integer - 'null' vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. Returned as `null` for non-`vpc` type interfaces. example: 111 readOnly: true type: - integer - 'null' required: - purpose type: object x-akamai: file-path: schemas/linode-config-interface.yaml x-akamai: file-path: schemas/added-post-linode-config-interface.yaml x-example: x-ref: ../examples/post-linode-config-interface.json required: true responses: '200': content: application/json: schema: additionalProperties: false description: The network interface to apply to this Linode's configuration profile. properties: active: description: __Read-only__ Returns `true` if the interface is in use, meaning that the Linode has been booted using the configuration profile to which the interface belongs. example: true readOnly: true type: boolean id: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 ip_ranges: description: 'IPv4 CIDR VPC subnet ranges that are routed to this interface. When included in a request: - A range can''t include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Submit this as an empty array removes all existing values. - Omit this object to leave existing values as is. <> > 📘 > > This is only supported for interfaces with a `purpose` of `vpc`.' example: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: - array - 'null' ipam_address: description: 'This interface''s private IP address in classless inter-domain routing (CIDR) notation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vlan`: - To avoid conflicting addresses, make sure this value is unique for each `vlan` interface. - This should be unique among devices attached to the VLAN to avoid conflict. - If Network Helper is enabled, the Linode''s interface will be 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/). For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: 10.0.0.1/24 format: ip/netmask type: - string - 'null' x-linode-cli-display: 4 ipv4: additionalProperties: false description: IPv4 addresses configured for this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if no `vpc` interface is assigned. properties: nat_1_1: anyOf: - format: ip minLength: 1 title: An available public IPv4 address type: string - enum: - any title: The assigned public IPv4 address type: string description: 'The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface''s VPC subnet IPv4 address. - Only supported for interfaces with a `purpose` of `vpc`. - Returned as `null` if no 1:1 NAT is set for a `vpc` type interface. - Returned as an empty string (`""`) for non-`vpc` type interfaces. When included in a request: - 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. - A specified address can''t be shared with another Linode. - Omit this object or include it and set it to `null` or an empty string (`""`) to block creation of a 1:1 NAT. <> > 📘 > > 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 type: - string - 'null' 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 (`""`) for non-`vpc` type interfaces. When included in a request: - The `vpc` can''t be assigned to an existing Linode as an address or in a range. - The target address can''t be the first two or last two addresses in the subnet IPv4 range. - If omitted, a valid address within the Subnet IPv4 range is automatically assigned.' example: 10.0.0.2 format: ip type: - string - 'null' type: object label: description: '__Filterable__ The name of this interface. For interfaces with a `purpose` of `vlan`: - Required. - This needs to be unique among a Linode''s interfaces. A Linode can''t be attached to the same VLAN multiple times. - This can only contain ASCII letters, numbers, and dashes (`-`). You can''t use two consecutive dashes (`--`). - 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, run the [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans) operation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: example-interface maxLength: 64 minLength: 1 pattern: '[a-zA-Z0-9-]+' type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 2 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. > 📘 > > This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.' example: true type: boolean purpose: description: 'The type of interface. This can be `public`, `vlan`, or `vpc`. For interfaces with a `purpose` of `public`: - You can only define one `public` interface per Linode. - The Linode''s default public IPv4 address is assigned to the `public` interface. - A Linode needs a `public` interface in the first or `eth0` position to be reachable via the public internet, after it boots. If no `public` interface is configured, you can only access the Linode through [LISH](https://www.linode.com/docs/products/compute/compute-instances/guides/lish/), or through another Linode that''s connected to the same VLAN or VPC. For interfaces with a `purpose` of `vlan`: - Configuring this `purpose` of interface attaches a Linode to the VLAN with the specified `label`. - If an `ipam_address` is configured, the Linode uses this address. For interfaces with a `purpose` of `vpc`: - Configuring this `purpose` of interface attaches a Linode to an 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.' enum: - public - vlan - vpc example: vlan type: string x-linode-cli-display: 3 subnet_id: description: 'The `id` of the VPC subnet for this interface. Use this value in a request to assign a Linode to a VPC subnet. - Required for `vpc` type interfaces. - Returned as `null` for non-`vpc` type interfaces. - Once you''ve assigned a VPC subnet to an interface, you can''t update it. - You need to reboot a Linode using the interface''s configuration profile to assign the Linode to a VPC subnet.' example: 101 type: - integer - 'null' vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. Returned as `null` for non-`vpc` type interfaces. example: 111 readOnly: true type: - integer - 'null' required: - purpose type: object x-akamai: file-path: schemas/linode-config-interface.yaml x-example: x-ref: ../examples/post-linode-config-interface-200.json description: Configuration profile interface successfully added. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_write summary: Add a configuration profile interface tags: - Configuration profile interfaces x-akamai: tabs: - syntax: "linode-cli linodes config-interface-add $linodeId $configId \\\n --purpose vpc \\\n --primary false \\\n --subnet_id 101 \\\n --ipv4.vpc \"10.0.1.2\" \\\n --ipv4.nat_1_1 \"203.0.113.2\"" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: config-interface-add x-linode-grant: read_write get: description: 'Returns all configuration profile interfaces assigned to a specific configuration profile, on a specific Linode. To access this operation, your user needs the `read_write` grant for the Linode. > --- - __CLI__. ``` linode-cli linodes config-interfaces-list $linodeId $configId ``` Learn more... - __OAuth scopes__. ``` linodes:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-linode-config-interfaces operationId: get-linode-config-interfaces responses: '200': content: application/json: schema: description: '`interfaces` is applicable only to legacy configuration profiles and does not apply to [Linode interfaces](https://techdocs.akamai.com/linode-api/reference/post-linode-interface). From one to three network interfaces to add to this Linode''s configuration profile. The position in the array determines which of the Linode''s network interfaces is configured: - First [0]: `eth0` - Second [1]: `eth1` - Third [2]: `eth2` When updating a Linode''s legacy interfaces, _each interface must be redefined_. An empty `interfaces` array results in a default `public` type interface configuration only. If no public Interface is configured, public IP addresses are still assigned to the Linode but will not be usable without manual configuration. > 📘 > > Changes to Linode Interface configurations can be enabled by rebooting the Linode. `vpc` details See the [VPC documentation](https://www.linode.com/docs/products/networking/vpc/#technical-specifications) guide for its specifications and limitations. `vlan` details - 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. - See the [VLANs Overview](https://www.linode.com/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.' example: - id: 101 ipam_address: null ipv4: null label: null primary: false purpose: public subnet_id: null vpc_id: null - id: 102 ipam_address: 10.0.0.1/24 ipv4: nat_1_1: null vpc: 10.0.0.2 label: vlan-1 primary: false purpose: vlan subnet_id: null vpc_id: null - id: 103 ipam_address: null ipv4: nat_1_1: 203.0.113.2 vpc: 10.0.1.2 label: null primary: true purpose: vpc subnet_id: 101 vpc_id: 111 items: additionalProperties: false description: The network interface to apply to this Linode's configuration profile. properties: active: description: __Read-only__ Returns `true` if the interface is in use, meaning that the Linode has been booted using the configuration profile to which the interface belongs. example: true readOnly: true type: boolean id: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 ip_ranges: description: 'IPv4 CIDR VPC subnet ranges that are routed to this interface. When included in a request: - A range can''t include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Submit this as an empty array removes all existing values. - Omit this object to leave existing values as is. <> > 📘 > > This is only supported for interfaces with a `purpose` of `vpc`.' example: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: - array - 'null' ipam_address: description: 'This interface''s private IP address in classless inter-domain routing (CIDR) notation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vlan`: - To avoid conflicting addresses, make sure this value is unique for each `vlan` interface. - This should be unique among devices attached to the VLAN to avoid conflict. - If Network Helper is enabled, the Linode''s interface will be 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/). For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: 10.0.0.1/24 format: ip/netmask type: - string - 'null' x-linode-cli-display: 4 ipv4: additionalProperties: false description: IPv4 addresses configured for this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if no `vpc` interface is assigned. properties: nat_1_1: anyOf: - format: ip minLength: 1 title: An available public IPv4 address type: string - enum: - any title: The assigned public IPv4 address type: string description: 'The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface''s VPC subnet IPv4 address. - Only supported for interfaces with a `purpose` of `vpc`. - Returned as `null` if no 1:1 NAT is set for a `vpc` type interface. - Returned as an empty string (`""`) for non-`vpc` type interfaces. When included in a request: - 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. - A specified address can''t be shared with another Linode. - Omit this object or include it and set it to `null` or an empty string (`""`) to block creation of a 1:1 NAT. <> > 📘 > > 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 type: - string - 'null' 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 (`""`) for non-`vpc` type interfaces. When included in a request: - The `vpc` can''t be assigned to an existing Linode as an address or in a range. - The target address can''t be the first two or last two addresses in the subnet IPv4 range. - If omitted, a valid address within the Subnet IPv4 range is automatically assigned.' example: 10.0.0.2 format: ip type: - string - 'null' type: object label: description: '__Filterable__ The name of this interface. For interfaces with a `purpose` of `vlan`: - Required. - This needs to be unique among a Linode''s interfaces. A Linode can''t be attached to the same VLAN multiple times. - This can only contain ASCII letters, numbers, and dashes (`-`). You can''t use two consecutive dashes (`--`). - 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, run the [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans) operation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: example-interface maxLength: 64 minLength: 1 pattern: '[a-zA-Z0-9-]+' type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 2 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. > 📘 > > This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.' example: true type: boolean purpose: description: 'The type of interface. This can be `public`, `vlan`, or `vpc`. For interfaces with a `purpose` of `public`: - You can only define one `public` interface per Linode. - The Linode''s default public IPv4 address is assigned to the `public` interface. - A Linode needs a `public` interface in the first or `eth0` position to be reachable via the public internet, after it boots. If no `public` interface is configured, you can only access the Linode through [LISH](https://www.linode.com/docs/products/compute/compute-instances/guides/lish/), or through another Linode that''s connected to the same VLAN or VPC. For interfaces with a `purpose` of `vlan`: - Configuring this `purpose` of interface attaches a Linode to the VLAN with the specified `label`. - If an `ipam_address` is configured, the Linode uses this address. For interfaces with a `purpose` of `vpc`: - Configuring this `purpose` of interface attaches a Linode to an 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.' enum: - public - vlan - vpc example: vlan type: string x-linode-cli-display: 3 subnet_id: description: 'The `id` of the VPC subnet for this interface. Use this value in a request to assign a Linode to a VPC subnet. - Required for `vpc` type interfaces. - Returned as `null` for non-`vpc` type interfaces. - Once you''ve assigned a VPC subnet to an interface, you can''t update it. - You need to reboot a Linode using the interface''s configuration profile to assign the Linode to a VPC subnet.' example: 101 type: - integer - 'null' vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. Returned as `null` for non-`vpc` type interfaces. example: 111 readOnly: true type: - integer - 'null' required: - purpose type: object x-akamai: file-path: schemas/linode-config-interface.yaml maxItems: 3 minItems: 1 type: array uniqueItems: true x-akamai: file-path: schemas/linode-config-interfaces.yaml x-example: x-ref: ../examples/get-linode-config-interfaces-200.json description: An ordered array of configuration profile interface objects. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_only summary: List configuration profile interfaces tags: - Configuration profile interfaces x-akamai: tabs: - syntax: linode-cli linodes config-interfaces-list $linodeId $configId title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - config-interfaces-list - config-interfaces-ls x-linode-grant: read_only /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/order: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The `id` of the Linode. example: '{{linodeId}}' in: path name: linodeId required: true schema: example: 234 type: integer x-akamai: file-path: parameters/linode-id.yaml - description: The `id` of the Configuration Profile. example: '{{configId}}' in: path name: configId required: true schema: example: 521 type: integer x-akamai: file-path: parameters/config-id-profile.yaml x-akamai: file-path: paths/order.yaml path-info: /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/order x-linode-cli-command: linodes post: description: 'Reorders the existing Interfaces of a Configuration Profile. - The User accessing this operation must have `read_write` grants to the Linode. > --- - __CLI__. ``` linode-cli linodes config-interfaces-order $linodeId $configId \ --ids 101 --ids 102 --ids 103 ``` Learn more... - __OAuth scopes__. ``` linodes:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interfaces operationId: post-linode-config-interfaces requestBody: content: application/json: schema: additionalProperties: false description: Linode Configuration Interfaces Order request object. properties: ids: description: 'An ordered array of existing Configuration Profile Interface `id`s. - All current Interface `id`s must be present in the array. - If the Configuration Profile contains Interfaces and is active on the Linode, the Linode must first be shut down prior to running this operation. - Reordering takes effect after rebooting the Linode with this Configuration Profile. The position in the array determines which of the Linode''s network Interfaces is configured: - First [0]: eth0 - Second [1]: eth1 - Third [2]: eth2' items: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 type: array required: - ids type: object x-akamai: file-path: schemas/added-post-linode-config-interfaces.yaml x-example: x-ref: ../examples/post-linode-config-interfaces.json description: The desired Interface order for the Configuration Profile. required: true responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/post-linode-config-interfaces-200.json description: Interfaces successfully reordered. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_write summary: Reorder configuration profile interfaces tags: - Configuration profile interfaces x-akamai: tabs: - syntax: "linode-cli linodes config-interfaces-order $linodeId $configId \\\n --ids 101 --ids 102 --ids 103" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: config-interfaces-order x-linode-grant: read_write /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The `id` of the Linode. example: '{{linodeId}}' in: path name: linodeId required: true schema: example: 234 type: integer x-akamai: file-path: parameters/linode-id.yaml - description: The `id` of the Configuration Profile. example: '{{configId}}' in: path name: configId required: true schema: example: 521 type: integer x-akamai: file-path: parameters/config-id-profile.yaml - description: The `id` of the Linode Configuration Profile Interface. example: '{{interfaceId}}' in: path name: interfaceId required: true schema: example: 916 type: integer x-akamai: file-path: parameters/interface-id-path.yaml x-akamai: file-path: paths/interface.yaml path-info: /{apiVersion}/linode/instances/{linodeId}/configs/{configId}/interfaces/{interfaceId} x-linode-cli-command: linodes get: description: 'Returns a single configuration profile interface. To access this operation, your user needs at least the `read_only` grant for the Linode. > --- - __CLI__. ``` linode-cli linodes config-interface-view $linodeId $configId $interfaceId ``` Learn more... - __OAuth scopes__. ``` linodes:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-linode-config-interface operationId: get-linode-config-interface responses: '200': content: application/json: schema: additionalProperties: false description: The network interface to apply to this Linode's configuration profile. properties: active: description: __Read-only__ Returns `true` if the interface is in use, meaning that the Linode has been booted using the configuration profile to which the interface belongs. example: true readOnly: true type: boolean id: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 ip_ranges: description: 'IPv4 CIDR VPC subnet ranges that are routed to this interface. When included in a request: - A range can''t include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Submit this as an empty array removes all existing values. - Omit this object to leave existing values as is. <> > 📘 > > This is only supported for interfaces with a `purpose` of `vpc`.' example: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: - array - 'null' ipam_address: description: 'This interface''s private IP address in classless inter-domain routing (CIDR) notation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vlan`: - To avoid conflicting addresses, make sure this value is unique for each `vlan` interface. - This should be unique among devices attached to the VLAN to avoid conflict. - If Network Helper is enabled, the Linode''s interface will be 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/). For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: 10.0.0.1/24 format: ip/netmask type: - string - 'null' x-linode-cli-display: 4 ipv4: additionalProperties: false description: IPv4 addresses configured for this interface. This only applies to interfaces with a `purpose` of `vpc`. Returned as `null` if no `vpc` interface is assigned. properties: nat_1_1: anyOf: - format: ip minLength: 1 title: An available public IPv4 address type: string - enum: - any title: The assigned public IPv4 address type: string description: 'The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface''s VPC subnet IPv4 address. - Only supported for interfaces with a `purpose` of `vpc`. - Returned as `null` if no 1:1 NAT is set for a `vpc` type interface. - Returned as an empty string (`""`) for non-`vpc` type interfaces. When included in a request: - 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. - A specified address can''t be shared with another Linode. - Omit this object or include it and set it to `null` or an empty string (`""`) to block creation of a 1:1 NAT. <> > 📘 > > 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 type: - string - 'null' 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 (`""`) for non-`vpc` type interfaces. When included in a request: - The `vpc` can''t be assigned to an existing Linode as an address or in a range. - The target address can''t be the first two or last two addresses in the subnet IPv4 range. - If omitted, a valid address within the Subnet IPv4 range is automatically assigned.' example: 10.0.0.2 format: ip type: - string - 'null' type: object label: description: '__Filterable__ The name of this interface. For interfaces with a `purpose` of `vlan`: - Required. - This needs to be unique among a Linode''s interfaces. A Linode can''t be attached to the same VLAN multiple times. - This can only contain ASCII letters, numbers, and dashes (`-`). You can''t use two consecutive dashes (`--`). - 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, run the [List VLANs](https://techdocs.akamai.com/linode-api/reference/get-vlans) operation. For interfaces with a `purpose` of `public`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response. For interfaces with a `purpose` of `vpc`: - If you include this in a request, set it to an empty string (`""`) or `null`. - Returned as `null` in a response.' example: example-interface maxLength: 64 minLength: 1 pattern: '[a-zA-Z0-9-]+' type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 2 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. > 📘 > > This needs to be set to `false` for any interface that uses `vlan` as its `purpose`.' example: true type: boolean purpose: description: 'The type of interface. This can be `public`, `vlan`, or `vpc`. For interfaces with a `purpose` of `public`: - You can only define one `public` interface per Linode. - The Linode''s default public IPv4 address is assigned to the `public` interface. - A Linode needs a `public` interface in the first or `eth0` position to be reachable via the public internet, after it boots. If no `public` interface is configured, you can only access the Linode through [LISH](https://www.linode.com/docs/products/compute/compute-instances/guides/lish/), or through another Linode that''s connected to the same VLAN or VPC. For interfaces with a `purpose` of `vlan`: - Configuring this `purpose` of interface attaches a Linode to the VLAN with the specified `label`. - If an `ipam_address` is configured, the Linode uses this address. For interfaces with a `purpose` of `vpc`: - Configuring this `purpose` of interface attaches a Linode to an 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.' enum: - public - vlan - vpc example: vlan type: string x-linode-cli-display: 3 subnet_id: description: 'The `id` of the VPC subnet for this interface. Use this value in a request to assign a Linode to a VPC subnet. - Required for `vpc` type interfaces. - Returned as `null` for non-`vpc` type interfaces. - Once you''ve assigned a VPC subnet to an interface, you can''t update it. - You need to reboot a Linode using the interface''s configuration profile to assign the Linode to a VPC subnet.' example: 101 type: - integer - 'null' vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. Returned as `null` for non-`vpc` type interfaces. example: 111 readOnly: true type: - integer - 'null' required: - purpose type: object x-akamai: file-path: schemas/linode-config-interface.yaml x-example: x-ref: ../examples/get-linode-config-interface-200.json description: A configuration interface object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_only summary: Get a configuration profile interface tags: - Configuration profile interfaces x-akamai: tabs: - syntax: linode-cli linodes config-interface-view $linodeId $configId $interfaceId title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - config-interface-view x-linode-grant: read_only put: description: 'Update a `vpc` or `public` configuration profile interface for a specific configuration profile, on a specific Linode. - To access this operation, your user needs the `read_write` grant for the Linode. - A successful request triggers a `linode_config_update` event. - Only certain attributes can be updated for a configuration profile interface. You need to add a new configuration profile interface on your Linode if you need new values for any other attribute. Here are the supported objects, based on the interface''s `purpose`: - `public`. The `primary` attribute. - `vpc`. The `ip_ranges`, `ipv4`, or `primary` attributes. - You can''t update a configuration profile with a `purpose` of `vlan`. > --- - __CLI__. ``` linode-cli linodes config-interface-update $linodeId $configId $interfaceId \ --primary true \ --ipv4.vpc "10.0.1.2" \ --ipv4.nat_1_1 "203.0.113.2" ``` Learn more... - __OAuth scopes__. ``` linodes:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-linode-config-interface operationId: put-linode-config-interface requestBody: content: application/json: schema: additionalProperties: false description: Linode configuration profile interface update request object. properties: ip_ranges: description: 'IPv4 CIDR VPC subnet ranges that are routed to this interface. - A range can''t include any addresses that are assigned to an active Linode or another VPC subnet. - When updating, you need to include any existing ranges to maintain them. If a range is left out, it will be removed. - Include this as an empty array (`[]`) to remove all existing `nat_1_1` values. - Omit this array to leave all existing `ip_ranges` as is. <> > 📘 > > This only applies to interfaces with a `purpose` of `vpc`.' example: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: array ipv4: additionalProperties: false description: 'IPv4 addresses configured for this interface. > 📘 > > This only applies to interfaces with a `purpose` of `vpc`.' properties: nat_1_1: anyOf: - format: ip minLength: 1 title: An available public IPv4 address type: string - enum: - any title: The assigned public IPv4 address type: string description: 'The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the interface''s VPC subnet IPv4 address. - 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. - A specified address can''t be used on another Linode. - Include this as an empty object (`""`) to remove an existing `nat_1_1` value. - Omit this object or include it and set it to `null` to leave an existing `nat_1_1` value as is.' example: 203.0.113.2 type: - string - 'null' vpc: description: 'The VPC subnet IPv4 address for this interface. - The `vpc` can''t be assigned to an existing Linode as an address or in a range. - The target address can''t be the first two or last two addresses in the subnet IPv4 range. - If omitted, a valid address within the subnet IPv4 range is automatically assigned.' example: 10.0.0.2 format: ip type: - string - 'null' type: object primary: description: 'Set to `true` to label this configuration profile interface as the default route to the Linode. - Each Linode can have one interface set as its `primary`. - If you don''t specifically set a `primary`, the first non-`vlan` type interface is automatically treated as the primary.' example: '{{primary}}' type: boolean type: object x-akamai: file-path: schemas/added-put-linode-config-interface.yaml x-example: x-ref: ../examples/put-linode-config-interface.json required: true responses: '200': content: application/json: schema: additionalProperties: false description: The network interface to apply to this Linode's configuration profile. properties: active: description: __Read-only__ Returned as `true` if the interface has been booted using the configuration profile to which the interface belongs. example: true readOnly: true type: boolean id: description: __Read-only__ The unique ID representing this interface. example: 101 readOnly: true type: integer x-linode-cli-display: 1 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: - 10.0.0.64/26 - fd04:495a:691c:971c::1:0/112 items: format: ip type: string type: - array - 'null' 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`. > 📘 > > 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 type: - string - 'null' x-linode-cli-display: 4 ipv4: additionalProperties: false description: IPv4 addresses configured 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`. 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: 203.0.113.2 format: ip type: - string - 'null' 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: 10.0.0.2 format: ip type: - string - 'null' type: object label: description: __Filterable__ The name set for an interface with a `purpose` of `vlan`. Returned as `null` if the interface has a `purpose` of `public` or `vpc`. example: example-interface maxLength: 64 minLength: 1 pattern: '[a-zA-Z0-9-]+' type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 2 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`. > 📘 > > The value needs to `false` for any interface that uses `vlan` as its `purpose`.' example: true type: boolean purpose: description: 'The type of interface. This can be `public`, `vlan`, or `vpc`. For interfaces with a `purpose` of `public`: - You can only define one `public` interface per Linode. - The Linode''s default public IPv4 address is assigned to the `public` interface. - A Linode needs a `public` interface in the first or `eth0` position to be reachable via the public internet, after it boots. If no `public` interface is configured, you can only access the Linode through [LISH](https://www.linode.com/docs/products/compute/compute-instances/guides/lish/), or through another Linode that''s connected to the same VLAN or VPC. For interfaces with a `purpose` of `vlan`: - The target Linode is attached to the VLAN with the specified `label`. - If an `ipam_address` is configured, the Linode uses this address. For interfaces with a `purpose` of `vpc`: - The target Linode is attached to an 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.' enum: - public - vlan - vpc example: vlan type: string 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`. > 📘 > > You need to reboot a Linode using the interface''s configuration profile to assign the Linode to a VPC subnet.' example: 101 type: - integer - 'null' vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. Returned as `null` for non-`vpc` type interfaces. example: 111 readOnly: true type: - integer - 'null' required: - purpose type: object x-akamai: file-path: schemas/linode-config-update.yaml x-example: x-ref: ../examples/get-linode-config-interface-200.json description: Configuration profile interface successfully updated. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_write summary: Update a configuration profile interface tags: - Configuration profile interfaces x-akamai: tabs: - syntax: "linode-cli linodes config-interface-update $linodeId $configId $interfaceId \\\n --primary true \\\n --ipv4.vpc \"10.0.1.2\" \\\n --ipv4.nat_1_1 \"203.0.113.2\"" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: config-interface-update x-linode-grant: read_write delete: description: 'Deletes a configuration profile interface from a specific configuration profile, on a specific Linode. - To access this operation, your user needs the `read_write` grant for the Linode. - A successful request triggers a `linode_config_update` event. - You can''t delete an active configuration profile interface. First, you need to shut down the associated Linode or restart it using another configuration profile. > --- - __CLI__. ``` linode-cli linodes config-interface-delete $linodeId $configId $interfaceId ``` Learn more... - __OAuth scopes__. ``` linodes:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-linode-config-interface operationId: delete-linode-config-interface responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-linode-config-interface-200.json description: Configuration profile interface successfully deleted. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - linodes:read_write summary: Delete a configuration profile interface tags: - Configuration profile interfaces x-akamai: tabs: - syntax: linode-cli linodes config-interface-delete $linodeId $configId $interfaceId title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: linodes:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: config-interface-delete x-linode-grant: read_write components: securitySchemes: oauth: flows: authorizationCode: authorizationUrl: https://login.linode.com/oauth/authorize scopes: account:read_only: Allows access to GET information about your account. account:read_write: Allows access to all endpoints related to your account. domains:read_only: Allows access to GET Domains on your account. domains:read_write: Allows access to all Domain endpoints. events:read_only: Allows access to GET your Events. events:read_write: Allows access to all endpoints related to your Events. firewall:read_only: Allows access to GET information about your Firewalls. firewall:read_write: Allows access to all Firewall endpoints. images:read_only: Allows access to GET your Images. images:read_write: Allows access to all endpoints related to your Images. ips:read_only: Allows access to GET your ips. ips:read_write: Allows access to all endpoints related to your ips. linodes:read_only: Allows access to GET Linodes on your account. linodes:read_write: Allow access to all endpoints related to your Linodes. lke:read_only: Allows access to GET LKE Clusters on your account. lke:read_write: Allows access to all endpoints related to LKE Clusters on your account. longview:read_only: Allows access to GET your Longview Clients. longview:read_write: Allows access to all endpoints related to your Longview Clients. monitor:read-write: Allows access to all Monitor (Akamai Cloud Pulse) endpoints. monitor:read_only: Allows access to Monitor (Akamai Cloud Pulse) data. nodebalancers:read_only: Allows access to GET NodeBalancers on your account. nodebalancers:read_write: Allows access to all NodeBalancer endpoints. object_storage:read_only: Allows access to GET information related to your Object Storage. object_storage:read_write: Allows access to all Object Storage endpoints. stackscripts:read_only: Allows access to GET your StackScripts. stackscripts:read_write: Allows access to all endpoints related to your StackScripts. volumes:read_only: Allows access to GET your Volumes. volumes:read_write: Allows access to all endpoints related to your Volumes. vpc:read_write: Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion. tokenUrl: https://login.linode.com/oauth/token type: oauth2 personalAccessToken: scheme: bearer type: http externalDocs: description: See documentation for Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference x-readme: samples-languages: - curl - python - node