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 IP addresses API' version: 4.215.0 servers: - url: https://api.linode.com tags: - description: Use these operations to view and manage the IP addresses assigned to your Linodes. name: IP Addresses paths: /{apiVersion}/linode/instances/{linodeId}/ips: 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: ID of the Linode to look up. example: '{{linodeId}}' in: path name: linodeId required: true schema: example: 234 type: integer x-akamai: file-path: parameters/linode-id-path.yaml x-akamai: file-path: paths/linode-ips.yaml path-info: /{apiVersion}/linode/instances/{linodeId}/ips x-linode-cli-command: linodes post: description: 'Allocates a public or private IPv4 address to a Linode. Public IP Addresses, after the one included with each Linode, incur an additional monthly charge. If you need an additional public IP Address you must request one - please Open a support ticket. You may not add more than one private IPv4 address to a single Linode. > --- - __CLI__. ``` linode-cli linodes ip-add 123 \ --type ipv4 \ --public true ``` 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-add-linode-ip operationId: post-add-linode-ip requestBody: content: application/json: schema: additionalProperties: false properties: public: description: Whether to create a public or private IPv4 address. example: '{{public}}' type: boolean type: description: The type of address you are allocating. Only IPv4 addresses may be allocated through this operation. enum: - ipv4 example: '{{type}}' type: string required: - type - public type: object x-akamai: file-path: schemas/added-post-add-linode-ip.yaml x-example: x-ref: ../examples/post-add-linode-ip.json description: Information about the address you are creating. required: true responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/post-add-linode-ip-200.json description: IP address was successfully allocated. 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: Allocate an IPv4 address tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli linodes ip-add 123 \\\n --type ipv4 \\\n --public true" 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: ip-add x-linode-grant: read_write get: description: 'Returns networking information for a single Linode. > 📘 > > If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, the response lists address information for all of the VPCs. > --- - __CLI__. ``` linode-cli linodes ips-list 123 ``` 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-ips operationId: get-linode-ips responses: '200': content: application/json: schema: additionalProperties: false properties: ipv4: additionalProperties: false description: __Read-only__ Information about this Linode's IPv4 addresses. properties: private: description: __Read-only__ A list of private IP Address objects belonging to this Linode. items: additionalProperties: false description: A private IPv4 address that exists in Linode's system. properties: address: description: __Read-only__ The private IPv4 address. example: 192.168.133.234 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: null format: ip readOnly: true type: - string - 'null' linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 17 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: false readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. example: null type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.128.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. example: ipv4 readOnly: true type: string x-linode-cli-display: 2 type: object x-akamai: file-path: schemas/ip-address-private.yaml readOnly: true type: array public: description: __Read-only__ A list of public IP Address objects belonging to this Linode. items: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml readOnly: true type: array reserved: description: __Read-only__ A list of reserved IP Address objects belonging to this Linode. items: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml readOnly: true type: array shared: description: __Read-only__ A list of shared IP Address objects assigned to this Linode. items: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml readOnly: true type: array vpc: description: __Read-only__ A list of Virtual Private Cloud (VPC)-specific addresses or ranges for the Linode. items: additionalProperties: false description: A VPC IP address that exists in Linode's system, specific to the response for the [List VPC IP addresses](https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips) operation. Returned as an empty set for Linodes that are not part of a VPC. properties: active: description: __Filterable__, __Read-only__ Returns `true` if the VPC interface is in use, meaning that the Linode was powered on using the `config_id` to which the interface belongs. Otherwise returns `false`. example: true readOnly: true type: boolean x-akamai: labels: - Filterable x-linode-filterable: true address: description: __Read-only__ An IPv4 address configured for this VPC interface. These follow the [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918) private address format. Displayed as `null` if an `address_range`. example: 192.0.2.141 format: ip readOnly: true type: - string - 'null' x-linode-cli-display: 1 address_range: description: __Read-only__ A range of IPv4 addresses configured for this VPC interface. Displayed as `null` if a single `address`. readOnly: true type: - string - 'null' config_id: description: __Filterable__, __Read-only__ The globally general entity identifier for the Linode configuration profile that includes the VPC. If this is a VPC Linode interface, the value is `null`. example: 4567 readOnly: true type: - integer - 'null' x-akamai: labels: - Filterable x-linode-filterable: true gateway: description: __Read-only__ The default gateway for the VPC subnet that the IP or IP range belongs to. example: 192.0.2.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The globally general API entity identifier for the Linode interface. example: 2435 readOnly: true type: integer x-akamai: status: BETA linode_id: description: __Filterable__, __Read-only__ The identifier for the Linode the VPC interface currently belongs to. example: 123 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true nat_1_1: description: __Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used. example: 192.168.0.42 format: ip readOnly: true type: string prefix: description: __Read-only__ The number of bits set in the `subnet_mask`. example: 24 readOnly: true type: - integer - 'null' region: description: __Filterable__, __Read-only__ The region of the VPC. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer x-linode-cli-display: 7 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`. example: 255.255.255.0 format: ip readOnly: true type: string vpc_id: description: __Filterable__, __Read-only__ The unique globally general API entity identifier for the VPC. example: 7654 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 8 x-linode-filterable: true type: object x-akamai: file-path: schemas/ip-addresses-vpc.yaml readOnly: true type: array readOnly: true type: object ipv6: additionalProperties: false description: __Read-only__ Information about this Linode's IPv6 addresses. properties: global: description: A list of IPv6 range objects assigned to this Linode. items: additionalProperties: false description: An object representing an IPv6 range. properties: prefix: description: The prefix length of the address. The total number of addresses that can be assigned from this range is calculated as 2(128 - prefix length). example: 64 type: integer x-linode-cli-display: 2 range: description: __Read-only__ The IPv6 address of this range. example: '2600:3c01::' readOnly: true type: string x-linode-cli-display: 1 region: description: __Read-only__ The region for this range of IPv6 addresses. example: us-east readOnly: true type: string x-linode-cli-display: 3 route_target: description: The IPv6 SLAAC address. example: 2600:3c01::ffff:ffff:ffff:ffff type: string type: object x-akamai: file-path: schemas/ipv6-range.yaml type: array link_local: additionalProperties: false description: A link-local IPv6 address that exists in Linode's system. properties: address: description: __Read-only__ The IPv6 link-local address. example: fe80::f03c:91ff:fe24:3a2f format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: fe80::1 readOnly: true type: string linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The network prefix. example: 64 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: false readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. example: null type: - string - 'null' x-linode-cli-display: 4 region: description: __Filterable__, __Read-only__ The Region this address resides in. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_mask: description: __Read-only__ The subnet mask. example: 'ffff:ffff:ffff:ffff::' format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. example: ipv6 readOnly: true type: string x-linode-cli-display: 2 type: object x-akamai: file-path: schemas/ip-address-v6-link-local.yaml slaac: additionalProperties: false description: A SLAAC IPv6 address that exists in Linode's system. properties: address: description: __Read-only__ The address. example: 2600:3c03::f03c:91ff:fe24:3a2f format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: fe80::1 readOnly: true type: string linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The network prefix. example: 64 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. example: null type: - string - 'null' x-linode-cli-display: 4 region: description: __Filterable__, __Read-only__ The Region this address resides in. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_mask: description: __Read-only__ The subnet mask. example: 'ffff:ffff:ffff:ffff::' format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. example: ipv6 readOnly: true type: string x-linode-cli-display: 2 type: object x-akamai: file-path: schemas/ip-address-v6-slaac.yaml readOnly: true type: object type: object x-akamai: file-path: schemas/added-get-linode-ips-200.yaml x-example: x-ref: ../examples/get-linode-ips-200.json x-linode-cli-subtables: - ipv4.public - ipv4.private - ipv4.shared - ipv4.reserved - ipv4.vpc - ipv6.link_local - ipv6.slaac - ipv6.global description: Requested Linode's networking configuration. 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 networking information tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli linodes ips-list 123 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: ips-list x-linode-grant: read_only /{apiVersion}/linode/instances/{linodeId}/ips/{address}: 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-path-820d9f86.yaml - description: The IP address. example: '{{address}}' in: path name: address required: true schema: format: ip type: string x-akamai: file-path: parameters/address-path-59ea51e6.yaml x-akamai: file-path: paths/linode-ip-address.yaml path-info: /{apiVersion}/linode/instances/{linodeId}/ips/{address} x-linode-cli-command: linodes get: description: 'View information for a Linode''s set of IPs, its Linode interfaces and VPC IPs and ranges. > --- - __CLI__. ``` linode-cli linodes ip-view 123 97.107.143.141 ``` 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-ip operationId: get-linode-ip responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/get-linode-ip-200.json description: A single IP address. 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 Linode's IP address tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli linodes ip-view 123 97.107.143.141 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: ip-view x-linode-grant: read_only put: description: 'Updates the reverse DNS (RDNS) for a Linode''s IP Address. This may be done for both IPv4 and IPv6 addresses. Setting the RDNS to `null` for a public IPv4 address, resets it to the default `ip.linodeusercontent.com` RDNS value. > --- - __CLI__. ``` linode-cli linodes ip-update 123 \ 203.0.113.1 \ --rdns test.example.org ``` 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-ip operationId: put-linode-ip requestBody: content: application/json: schema: additionalProperties: false properties: rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: '{{rdns}}' type: - string - 'null' required: - rdns type: object x-akamai: file-path: schemas/added-put-linode-ip.yaml x-example: x-ref: ../examples/put-linode-ip.json description: The information to update for the IP address. responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/get-linode-ip-200.json description: The updated IP address record. 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 an IP address's RDNS for a Linode tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli linodes ip-update 123 \\\n 203.0.113.1 \\\n --rdns test.example.org" 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: ip-update x-linode-grant: read_write delete: description: 'Deletes a public or private IPv4 address associated with this Linode. This will fail if it is the Linode''s last remaining public IPv4 address, or if the address has a 1:1 NAT with an active VPC Subnet address. > 📘 > > You can''t use this operation to delete an IP assigned to a Linode interface. Run the update the Linode interface operation instead. > --- - __CLI__. ``` linode-cli linodes ip-delete 97.107.143.141 ``` 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-ip operationId: delete-linode-ip 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-ip-200.json description: IP address successfully removed. 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 an IPv4 address tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli linodes ip-delete 97.107.143.141 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: ip-delete x-linode-grant: read_write /{apiVersion}/networking/ips: 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 x-akamai: file-path: paths/networking-ips.yaml path-info: /{apiVersion}/networking/ips x-linode-cli-command: networking post: description: 'Allocates a new IPv4 Address on your Account. The Linode must be configured to support additional addresses - please Open a support ticket requesting additional addresses before attempting allocation. > 📘 > > You can run this operation for Linodes with legacy configuration interfaces. You can''t use it for Linodes with Linode interfaces. To allocate an IP for a Linode with Linode interfaces, use the Add a Linode interface operation and set the public IPv4 address to `auto`. > --- - __CLI__. ``` linode-cli networking ip-add \ --type ipv4 \ --public true \ --linode_id 123 ``` Learn more... - __OAuth scopes__. ``` ips:read_write 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-allocate-ip operationId: post-allocate-ip requestBody: content: application/json: schema: additionalProperties: false properties: linode_id: description: The ID of a Linode you have access to that this address will be allocated to. example: '{{linode_id}}' type: integer public: description: Whether to create a public or private IPv4 address. example: '{{public}}' type: boolean type: description: The type of address you are requesting. Only IPv4 addresses may be allocated through this operation. enum: - ipv4 example: '{{type}}' type: string required: - type - public - linode_id type: object x-akamai: file-path: schemas/added-post-allocate-ip.yaml x-example: x-ref: ../examples/post-allocate-ip.json description: Information about the address you are creating. required: true responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/post-allocate-ip-200.json description: IP Address allocated successfully. 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: - ips:read_write summary: Allocate an IP address tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli networking ip-add \\\n --type ipv4 \\\n --public true \\\n --linode_id 123" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: 'ips:read_write linodes:read_write' title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ip-add x-linode-grant: read_write get: description: 'Returns a paginated list of IP addresses on your account for Linodes or Linode interfaces, excluding private addresses. > 👍 > > if your application frequently accesses this operation and doesn''t require IPv6 RDNS data, you can use the `skip_ipv6_rdns` query string to improve performance. > --- - __CLI__. ``` linode-cli networking ips-list ``` Learn more... - __OAuth scopes__. ``` ips: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-ips operationId: get-ips parameters: - description: When `true`, the `rdns` property for any `ipv6` type addresses always returns `null` regardless of whether RDNS data exists for the address. example: '{{skip_ipv6_rdns}}' in: query name: skip_ipv6_rdns schema: default: false example: true type: boolean x-akamai: file-path: parameters/skip-ipv6-rdns-query.yaml responses: '200': content: application/json: example: data: - address: 198.51.100.141 gateway: 198.51.100.1 interface_id: 456 linode_id: 123 prefix: 24 public: true rdns: test.example.org region: us-east subnet_mask: 192.0.2.139 type: ipv4 vpc_nat_1_1: address: 192.0.2.1 subnet_id: 101 vpc_id: 111 page: 1 pages: 1 results: 1 schema: allOf: - additionalProperties: false description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml - properties: data: description: IP addresses that exist in Linode's system, either IPv4 or IPv6, specific to the response for the [List IP addresses](https://techdocs.akamai.com/linode-api/reference/get-ips) operation. items: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6, specific to the response for the [List IP addresses](https://techdocs.akamai.com/linode-api/reference/get-ips) operation. properties: address: description: __Filterable__, __Read-only__ The IP address. example: 192.0.2.141 format: ip readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true gateway: description: __Read-only__ The default gateway for this address. example: 192.0.2.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID this public IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this defaults to the Linode that this address was assigned to on creation. IPv4 addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value may not be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Filterable__, __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-filterable: true public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: __Filterable__ The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true region: description: __Filterable__, __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Filterable__, __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this interface. Empty if no address is configured as a 1:1 NAT. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this Interface. example: 111 readOnly: true type: integer type: object type: object type: array type: object description: The response data for the [List IP addresses](https://techdocs.akamai.com/linode-api/reference/get-ips) operation. x-akamai: file-path: schemas/ip-addresses-list-response.yaml description: A paginated list of IP Addresses. 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: - ips:read_only summary: List IP addresses tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli networking ips-list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: ips:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ips-list x-linode-grant: read_only /{apiVersion}/networking/ips/assign: 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 x-akamai: file-path: paths/ips-assign.yaml path-info: /{apiVersion}/networking/ips/assign x-linode-cli-command: networking post: description: 'Assign any set of IPv4 addresses and IPv6 ranges to Linodes in one region. This allows swapping, shuffling, or otherwise reorganizing IPs among your Linodes. The following restrictions apply: - All Linodes need to have at least one public IPv4 address assigned. - For Linode interfaces, the Linode needs to have a public interface, and the address it receives can''t be a private IPv4 address. - Linodes may have no more than one assigned private IPv4 address. - Linodes may have no more than one assigned IPv6 range. - Shared IP addresses cannot be swapped between Linodes. Open a support ticket to request additional IPv4 addresses or IPv6 ranges beyond standard account limits. > 📘 > > Removing an IP address that has been set as a Managed Linode''s `ssh.ip` causes the Managed Linode''s SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following operations: - Get a Linode''s managed settings - Update a Linode''s managed settings > 📘 > > Addresses with an active 1:1 NAT to a VPC Interface address cannot be assigned to other Linodes. > --- - __CLI__. ``` linode-cli networking ip-assign \ --region us-east \ --assignments.address 192.0.2.1 \ --assignments.linode_id 123 \ --assignments.address 2001:db8:3c4d:15::/64 \ --assignments.linode_id 234 ``` Learn more... - __OAuth scopes__. ``` ips:read_write 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-assign-ips operationId: post-assign-ips requestBody: content: application/json: schema: additionalProperties: false description: Request object for IP Addresses Assign (POST /networking/ips/assign). properties: assignments: description: The list of assignments to make. You must have read_write access to all IPs being assigned and all Linodes being assigned to in order for the assignments to succeed. items: additionalProperties: false properties: address: description: 'The IPv4 address or IPv6 range for this assignment. - Must be an IPv4 address or an IPv6 range you can access in the Region specified. - IPv6 ranges must include a prefix length of `/56` or `/64`, for example: `2001:db8:3c4d:15::/64`. - Assignment of an IPv6 range to a Linode updates the route target of the range to the assigned Linode''s SLAAC address. - Can be a public or private address. - For Linode interfaces, public IPv4 addresses or public IPv6 ranges can be exchanged on public interfaces. Private IPv4 addresses are not supported.' example: 192.0.2.1 format: ipv4|ipv6/prefix_length type: string linode_id: description: The ID of the Linode to assign this address to. The IP's previous Linode will lose this address, and must end up with at least one public address and no more than one private address once all assignments have been made. example: 123 type: integer required: - address - linode_id type: object type: array region: description: The ID of the Region in which these assignments are to take place. All IPs and Linodes must exist in this Region. example: '{{region}}' type: string required: - region - assignments type: object x-akamai: file-path: schemas/ip-addresses-assign-request.yaml x-example: x-ref: ../examples/post-assign-ips.json description: Information about what IPv4 address or IPv6 range to assign, and to which Linode. 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-assign-ips-200.json description: All assignments completed successfully. 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: - ips:read_write - linodes:read_write summary: Assign IP addresses tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli networking ip-assign \\\n --region us-east \\\n --assignments.address 192.0.2.1 \\\n --assignments.linode_id 123 \\\n --assignments.address 2001:db8:3c4d:15::/64 \\\n --assignments.linode_id 234" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: 'ips:read_write linodes:read_write' title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ip-assign x-linode-grant: read_write /{apiVersion}/networking/ips/share: 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 x-akamai: file-path: paths/ips-share.yaml path-info: /{apiVersion}/networking/ips/share x-linode-cli-command: networking post: description: 'Configure shared IPs. IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode''s IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses. IP failover requires configuration of a BGP based failover service within the internal system of the primary Linode. > 📘 > > A public IPv4 address can''t be shared if it''s configured for a 1:1 NAT on a legacy configuration profile VPC interface or on a Linode VPC interface. > --- - __CLI__. ``` linode-cli networking ip-share \ --linode_id 123 \ --ips 192.0.2.1 \ --ips 2001:db8:3c4d:15:: ``` Learn more... - __OAuth scopes__. ``` ips:read_write 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-share-ips operationId: post-share-ips requestBody: content: application/json: schema: additionalProperties: false description: A request object IP Addresses Share (POST /networking/ips/share). properties: ips: description: 'A list of secondary Linode IPs to share with the primary Linode. - Can include both IPv4 addresses and IPv6 ranges (omit /56 and /64 prefix lengths) - Can include both private and public IPv4 addresses. - You must have access to all of these addresses and they must be in the same Region as the primary Linode. - Enter an empty array to remove all shared IP addresses.' example: - 192.0.2.1 - '2001:db8:3c4d:15::' items: format: ip type: string type: array linode_id: description: The ID of the primary Linode that the addresses will be shared with. example: '{{linode_id}}' type: integer required: - linode_id - ips type: object x-akamai: file-path: schemas/ip-addresses-share-request.yaml x-example: x-ref: ../examples/post-share-ips.json description: Information about what IPs to share with which Linode. 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-share-ips-200.json description: IP Address sharing successful. 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: - ips:read_write - linodes:read_write summary: Share IP addresses tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli networking ip-share \\\n --linode_id 123 \\\n --ips 192.0.2.1 \\\n --ips 2001:db8:3c4d:15::" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: 'ips:read_write linodes:read_write' title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ip-share x-linode-grant: read_write /{apiVersion}/networking/ips/{address}: 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 address to operate on. example: '{{address}}' in: path name: address required: true schema: format: ip type: string x-akamai: file-path: parameters/address-path-e209a4cb.yaml x-akamai: file-path: paths/networking-ip-address.yaml path-info: /{apiVersion}/networking/ips/{address} x-linode-cli-command: networking get: description: 'Returns information about a single IP Address on your Account. > --- - __CLI__. ``` linode-cli networking ip-view 97.107.143.141 ``` Learn more... - __OAuth scopes__. ``` ips: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-ip operationId: get-ip responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/get-ip-200.json description: The requested IP Address. 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: - ips:read_only summary: Get an IP address tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli networking ip-view 97.107.143.141 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: ips:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ip-view x-linode-grant: read_only put: description: 'Sets RDNS on an IP Address. Forward DNS must already be set up for reverse DNS to be applied. If you set the RDNS to `null` for public IPv4 addresses, it will be reset to the default _ip.linodeusercontent.com_ RDNS value. > --- - __CLI__. ``` linode-cli networking ip-update \ 203.0.113.1 \ --rdns "test.example.org" ``` Learn more... - __OAuth scopes__. ``` ips: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-ip operationId: put-ip requestBody: content: application/json: schema: additionalProperties: false properties: rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: '{{rdns}}' type: - string - 'null' x-linode-cli-display: 4 required: - rdns type: object x-akamai: file-path: schemas/added-put-ip.yaml x-example: x-ref: ../examples/put-ip.json description: The information to update. required: true responses: '200': content: application/json: schema: additionalProperties: false description: An IP address that exists in Linode's system, either IPv4 or IPv6. properties: address: description: __Read-only__ The IP address. example: 97.107.143.141 format: ip readOnly: true type: string x-linode-cli-display: 1 gateway: description: __Read-only__ The default gateway for this address. example: 97.107.143.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The Linode interface ID that this IP address is assigned to. This value is `null` if a Linode interface is not assigned, or if the IP is assigned to a legacy configuration profile interface. example: 456 readOnly: true type: - integer - 'null' x-akamai: status: BETA x-linode-cli-display: 7 linode_id: description: __Read-only__ The ID of the Linode this address currently belongs to. For IPv4 addresses, this is by default the Linode that this address was assigned to on creation, and these addresses may be moved using the [Assign IPv4s to Linodes](https://techdocs.akamai.com/linode-api/reference/post-assign-ipv4s) operation. For SLAAC and link-local addresses, this value can't be changed. example: 123 readOnly: true type: integer x-linode-cli-display: 6 prefix: description: __Read-only__ The number of bits set in the subnet mask. example: 24 readOnly: true type: integer public: description: __Read-only__ Whether this is a public or private IP address. example: true readOnly: true type: boolean x-linode-cli-display: 3 rdns: description: The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set. example: test.example.org type: - string - 'null' x-linode-cli-display: 4 region: description: __Read-only__ The Region this IP address resides in. example: us-east readOnly: true type: string x-linode-cli-display: 5 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for this address. example: 255.255.255.0 format: ip readOnly: true type: string type: description: __Read-only__ The type of address this is. enum: - ipv4 - ipv6 - ipv6/pool - ipv6/range example: ipv4 readOnly: true type: string x-linode-cli-display: 2 vpc_nat_1_1: additionalProperties: false description: 'IPv4 address configured as a 1:1 NAT for this Interface. If no address is configured as a 1:1 NAT, `null` is returned. > 📘 > > Only allowed for `vpc` type interfaces.' properties: address: description: The IPv4 address that is configured as a 1:1 NAT for this VPC interface. example: 192.168.0.42 format: ipv4 type: string subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer vpc_id: description: __Read-only__ The `id` of the VPC configured for this interface. example: 111 readOnly: true type: integer type: object type: object x-akamai: file-path: schemas/ip-address.yaml x-example: x-ref: ../examples/get-ip-200.json description: RDNS set successfully. 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: - ips:read_write summary: Update an IP address's RDNS tags: - IP Addresses x-akamai: tabs: - syntax: "linode-cli networking ip-update \\\n 203.0.113.1 \\\n --rdns \"test.example.org\"" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: ips:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: ip-update x-linode-grant: read_write /{apiVersion}/vpcs/ips: 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 x-akamai: file-path: paths/vpcs-ips.yaml path-info: /{apiVersion}/vpcs/ips x-linode-cli-command: vpcs get: description: 'Returns a paginated list of all VPC IP addresses and address ranges on your account. > 📘 > > If a Linode has several configuration profiles that include a VPC interface, address information for all of them is listed in the response. Since VPCs can use the same address space, you may see duplicate IP addresses. > --- - __CLI__. ``` linode-cli vpcs ips-all-list ``` Learn more... - __OAuth scopes__. ``` ips: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-vpcs-ips operationId: get-vpcs-ips parameters: - description: The page of a collection to return. example: '{{page}}' in: query name: page required: false schema: default: 1 example: 6 minimum: 1 type: integer x-akamai: file-path: parameters/page-offset.yaml - description: The number of items to return per page. example: '{{page_size}}' in: query name: page_size schema: default: 100 example: 50 maximum: 500 minimum: 25 type: integer x-akamai: file-path: parameters/page-size.yaml responses: '200': content: application/json: example: data: - active: true address: 172.30.254.145 address_range: null config_id: 4567 gateway: 172.23.210.1 interface_id: 2435 linode_id: 123 nat_1_1: 192.0.2.1 prefix: 24 region: us-east subnet_id: 101 subnet_mask: 192.0.2.3 vpc_id: 7654 page: 1 pages: 1 results: 1 schema: additionalProperties: false allOf: - additionalProperties: false description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml - properties: data: items: additionalProperties: false description: A VPC IP address that exists in Linode's system, specific to the response for the [List VPC IP addresses](https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips) operation. Returned as an empty set for Linodes that are not part of a VPC. properties: active: description: __Filterable__, __Read-only__ Returns `true` if the VPC interface is in use, meaning that the Linode was powered on using the `config_id` to which the interface belongs. Otherwise returns `false`. example: true readOnly: true type: boolean x-akamai: labels: - Filterable x-linode-filterable: true address: description: __Read-only__ An IPv4 address configured for this VPC interface. These follow the [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918) private address format. Displayed as `null` if an `address_range`. example: 192.0.2.141 format: ip readOnly: true type: - string - 'null' x-linode-cli-display: 1 address_range: description: __Read-only__ A range of IPv4 addresses configured for this VPC interface. Displayed as `null` if a single `address`. readOnly: true type: - string - 'null' config_id: description: __Filterable__, __Read-only__ The globally general entity identifier for the Linode configuration profile that includes the VPC. If this is a VPC Linode interface, the value is `null`. example: 4567 readOnly: true type: - integer - 'null' x-akamai: labels: - Filterable x-linode-filterable: true gateway: description: __Read-only__ The default gateway for the VPC subnet that the IP or IP range belongs to. example: 192.0.2.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The globally general API entity identifier for the Linode interface. example: 2435 readOnly: true type: integer x-akamai: status: BETA linode_id: description: __Filterable__, __Read-only__ The identifier for the Linode the VPC interface currently belongs to. example: 123 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true nat_1_1: description: __Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used. example: 192.168.0.42 format: ip readOnly: true type: string prefix: description: __Read-only__ The number of bits set in the `subnet_mask`. example: 24 readOnly: true type: - integer - 'null' region: description: __Filterable__, __Read-only__ The region of the VPC. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer x-linode-cli-display: 7 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`. example: 255.255.255.0 format: ip readOnly: true type: string vpc_id: description: __Filterable__, __Read-only__ The unique globally general API entity identifier for the VPC. example: 7654 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 8 x-linode-filterable: true type: object x-akamai: file-path: schemas/ip-addresses-vpc.yaml type: array type: object x-akamai: file-path: schemas/added-get-vpcs-ips-200.yaml description: A paginated list of VPC interface IP addresses. 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: - ips:read_only summary: List VPC IP addresses tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli vpcs ips-all-list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: ips:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - ips-all-list - ips-all-ls x-linode-grant: read_only /{apiVersion}/vpcs/{vpcId}/ips: 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 VPC. example: '{{vpcId}}' in: path name: vpcId required: true schema: example: 527 type: integer x-akamai: file-path: parameters/vpc-id.yaml x-akamai: file-path: paths/vpc-ips.yaml path-info: /{apiVersion}/vpcs/{vpcId}/ips x-linode-cli-command: vpcs get: description: 'Returns a paginated list of IP addresses for a single VPC. > --- - __CLI__. ``` linode-cli vpcs ip-list 123 ``` Learn more... - __OAuth scopes__. ``` ips: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-vpc-ips operationId: get-vpc-ips parameters: - description: The page of a collection to return. example: '{{page}}' in: query name: page required: false schema: default: 1 example: 6 minimum: 1 type: integer x-akamai: file-path: parameters/page-offset.yaml - description: The number of items to return per page. example: '{{page_size}}' in: query name: page_size schema: default: 100 example: 50 maximum: 500 minimum: 25 type: integer x-akamai: file-path: parameters/page-size.yaml responses: '200': content: application/json: example: data: - active: true address: 198.51.100.42 address_range: null config_id: 4567 gateway: 192.0.2.1 interface_id: 2435 linode_id: 123 nat_1_1: 192.0.2.110 prefix: 24 region: us-east subnet_id: 101 subnet_mask: 192.0.2.1 vpc_id: 7654 page: 1 pages: 1 results: 1 schema: additionalProperties: false allOf: - additionalProperties: false description: An envelope for paginated response. When accessing a collection through a GET endpoint, the results are wrapped in this envelope which includes metadata about those results. Results are presented within a `data` array. See [Pagination](https://techdocs.akamai.com/linode-api/reference/pagination) for more information. properties: page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer type: object x-akamai: file-path: schemas/pagination-envelope.yaml - properties: data: items: additionalProperties: false description: A VPC IP address that exists in Linode's system, specific to the response for the [List VPC IP addresses](https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips) operation. Returned as an empty set for Linodes that are not part of a VPC. properties: active: description: __Filterable__, __Read-only__ Returns `true` if the VPC interface is in use, meaning that the Linode was powered on using the `config_id` to which the interface belongs. Otherwise returns `false`. example: true readOnly: true type: boolean x-akamai: labels: - Filterable x-linode-filterable: true address: description: __Read-only__ An IPv4 address configured for this VPC interface. These follow the [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918) private address format. Displayed as `null` if an `address_range`. example: 192.0.2.141 format: ip readOnly: true type: - string - 'null' x-linode-cli-display: 1 address_range: description: __Read-only__ A range of IPv4 addresses configured for this VPC interface. Displayed as `null` if a single `address`. readOnly: true type: - string - 'null' config_id: description: __Filterable__, __Read-only__ The globally general entity identifier for the Linode configuration profile that includes the VPC. If this is a VPC Linode interface, the value is `null`. example: 4567 readOnly: true type: - integer - 'null' x-akamai: labels: - Filterable x-linode-filterable: true gateway: description: __Read-only__ The default gateway for the VPC subnet that the IP or IP range belongs to. example: 192.0.2.1 format: ip readOnly: true type: - string - 'null' interface_id: description: __Beta__, __Read-only__ The globally general API entity identifier for the Linode interface. example: 2435 readOnly: true type: integer x-akamai: status: BETA linode_id: description: __Filterable__, __Read-only__ The identifier for the Linode the VPC interface currently belongs to. example: 123 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true nat_1_1: description: __Read-only__ The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn't used. example: 192.168.0.42 format: ip readOnly: true type: string prefix: description: __Read-only__ The number of bits set in the `subnet_mask`. example: 24 readOnly: true type: - integer - 'null' region: description: __Filterable__, __Read-only__ The region of the VPC. example: us-east readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true subnet_id: description: The `id` of the VPC Subnet for this interface. example: 101 type: integer x-linode-cli-display: 7 subnet_mask: description: __Read-only__ The mask that separates host bits from network bits for the `address` or `address_range`. example: 255.255.255.0 format: ip readOnly: true type: string vpc_id: description: __Filterable__, __Read-only__ The unique globally general API entity identifier for the VPC. example: 7654 readOnly: true type: integer x-akamai: labels: - Filterable x-linode-cli-display: 8 x-linode-filterable: true type: object x-akamai: file-path: schemas/ip-addresses-vpc.yaml type: array type: object x-akamai: file-path: schemas/added-get-vpc-ips-200.yaml description: The IP addresses for the requested VPC. 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: - ips:read_only summary: List a VPC's IP addresses tags: - IP Addresses x-akamai: tabs: - syntax: linode-cli vpcs ip-list 123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: ips:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - ips-list - ips-ls 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