You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Returns networking information for a single Linode.
8557
+
8558
+
**Note:** If the target Linode has several configuration profiles that include a Virtual Private Cloud (VPC) interface, address information for all of VPCs will be listed in the response.
8555
8559
operationId: getLinodeIPs
8556
8560
x-linode-cli-action: ips-list
8557
8561
security:
@@ -8593,20 +8597,27 @@ paths:
8593
8597
description: >
8594
8598
A list of private IP Address objects belonging to this Linode.
A list of shared IP Address objects assigned to this Linode.
8606
+
A list of Virtual Private Cloud (VPC)-specific addresses or ranges for the Linode.
8603
8607
reserved:
8604
8608
type: array
8605
8609
readOnly: true
8606
8610
items:
8607
8611
$ref: '#/components/schemas/IPAddress'
8608
8612
description: >
8609
8613
A list of reserved IP Address objects belonging to this Linode.
8614
+
shared:
8615
+
type: array
8616
+
readOnly: true
8617
+
items:
8618
+
$ref: '#/components/schemas/IPAddress'
8619
+
description: >
8620
+
A list of shared IP Address objects assigned to this Linode.
8610
8621
ipv6:
8611
8622
type: object
8612
8623
description: >
@@ -19902,6 +19913,85 @@ paths:
19902
19913
linode-cli vpcs update $vpcId \
19903
19914
--description "A description of my VPC."
19904
19915
--label cool-vpc
19916
+
/vpcs/ips:
19917
+
get:
19918
+
x-linode-grant: read_only
19919
+
tags:
19920
+
- VPCs
19921
+
summary: VPC IP Addresses List
19922
+
servers:
19923
+
- url: https://api.linode.com/v4
19924
+
parameters:
19925
+
- $ref: '#/components/parameters/pageOffset'
19926
+
- $ref: '#/components/parameters/pageSize'
19927
+
description: |
19928
+
Returns a paginated list of all VPC IP addresses and address ranges on your account.
19929
+
19930
+
**Note**: 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.
19931
+
operationId: getAllVPCIPs
19932
+
x-linode-cli-action:
19933
+
- ip-list
19934
+
- ip-ls
19935
+
security:
19936
+
- personalAccessToken: []
19937
+
- oauth:
19938
+
- ips:read_only
19939
+
responses:
19940
+
'200':
19941
+
description: A paginated list of VPC interface IP addresses.
* Any other value is rounded up to the nearest valid value.
21865
21955
@@ -23000,21 +23090,23 @@ components:
23000
23090
format: date-time
23001
23091
nullable: true
23002
23092
description: >
23003
-
Only Images created automatically from a deleted Linode (type=automatic) will expire.
23093
+
Only Images created automatically from a deleted Linode (type=automatic) will expire. `null` for private Images.
23004
23094
example: null
23005
23095
readOnly: true
23006
23096
eol:
23007
23097
type: string
23008
23098
format: date-time
23099
+
nullable: true
23009
23100
description: >
23010
-
The date of the public Image's planned end of life. `None` for private Images.
23101
+
The date of the public Image's planned end of life. `null` for private Images.
23011
23102
example: '2026-07-01T04:00:00'
23012
23103
readOnly: true
23013
23104
vendor:
23014
23105
x-linode-filterable: true
23015
23106
type: string
23107
+
nullable: true
23016
23108
description: >
23017
-
The upstream distribution vendor. `None` for private Images.
23109
+
The upstream distribution vendor. `null` for private Images.
23018
23110
example: Debian
23019
23111
readOnly: true
23020
23112
x-linode-cli-display: 3
@@ -23454,7 +23546,6 @@ components:
23454
23546
format: ipv4
23455
23547
description: |
23456
23548
The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
23457
-
example: 192.0.2.1
23458
23549
IPAddressesShareRequest:
23459
23550
type: object
23460
23551
description: A request object IP Addresses Share (POST /networking/ips/share)
@@ -23481,6 +23572,113 @@ components:
23481
23572
* Can include both private and public IPv4 addresses.
23482
23573
* You must have access to all of these addresses and they must be in the same Region as the primary Linode.
23483
23574
* Enter an empty array to remove all shared IP addresses.
23575
+
IPAddressesVPCListResponse:
23576
+
description: The response data for the VPC IP Addresses List and View operations.
23577
+
allOf:
23578
+
- $ref: '#/components/schemas/PaginationEnvelope'
23579
+
- type: object
23580
+
properties:
23581
+
data:
23582
+
type: array
23583
+
items:
23584
+
type: object
23585
+
description: >
23586
+
A VPC IP address that exists in Linode's system, specific to the response for the VPC IP Addresses List command. Returned as an empty set for Linodes that are not part of a VPC.
23587
+
properties:
23588
+
active:
23589
+
type: boolean
23590
+
description: >
23591
+
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`.
23592
+
example: true
23593
+
readOnly: true
23594
+
x-linode-filterable: true
23595
+
address:
23596
+
type: string
23597
+
format: ip
23598
+
description: >
23599
+
An IPv4 address configured for this VPC interface. Displayed as `null` if an `address_range`.
23600
+
example: 192.0.2.141
23601
+
nullable: true
23602
+
readOnly: true
23603
+
x-linode-cli-display: 1
23604
+
address_range:
23605
+
type: string
23606
+
description: >
23607
+
A range of IPv4 addresses configured for this VPC interface. Displayed as `null` if a single `address`.
23608
+
nullable: true
23609
+
readOnly: true
23610
+
config_id:
23611
+
type: integer
23612
+
description: >
23613
+
The globally general entity identifier for the Linode configuration profile where the VPC is included.
23614
+
example: 4567
23615
+
readOnly: true
23616
+
x-linode-filterable: true
23617
+
gateway:
23618
+
type: string
23619
+
format: ip
23620
+
description: >
23621
+
The default gateway for the VPC subnet that the IP or IP range belongs to.
23622
+
example: 192.0.2.1
23623
+
nullable: true
23624
+
readOnly: true
23625
+
interface_id:
23626
+
type: integer
23627
+
description: >
23628
+
The globally general API entity identifier for the Linode interface.
23629
+
example: 2435
23630
+
readOnly: true
23631
+
linode_id:
23632
+
type: integer
23633
+
description: >
23634
+
The identifier for the Linode the VPC interface currently belongs to.
23635
+
example: 123
23636
+
readOnly: true
23637
+
x-linode-cli-display: 6
23638
+
x-linode-filterable: true
23639
+
nat_1_1:
23640
+
type: string
23641
+
format: ip
23642
+
description: >
23643
+
The public IP address used for NAT 1:1 with the VPC. This is `null` if the VPC interface uses an `address_range` or NAT 1:1 isn't used.
23644
+
example: null
23645
+
nullable: true
23646
+
readOnly: true
23647
+
prefix:
23648
+
type: integer
23649
+
description: >
23650
+
The number of bits set in the `subnet_mask`.
23651
+
example: 24
23652
+
nullable: true
23653
+
readOnly: true
23654
+
region:
23655
+
type: string
23656
+
description: >
23657
+
The region of the VPC.
23658
+
example: us-east
23659
+
readOnly: true
23660
+
x-linode-filterable: true
23661
+
x-linode-cli-display: 5
23662
+
subnet_id:
23663
+
type: integer
23664
+
nullable: false
23665
+
description: |
23666
+
The `id` of the VPC Subnet for this interface.
23667
+
example: 101
23668
+
subnet_mask:
23669
+
type: string
23670
+
format: ip
23671
+
description: >
23672
+
The mask that separates host bits from network bits for the `address` or `address_range`.
23673
+
example: 255.255.255.0
23674
+
readOnly: true
23675
+
vpc_id:
23676
+
type: integer
23677
+
description: >
23678
+
The unique globally general API entity identifier for the VPC.
23679
+
example: 7654
23680
+
readOnly: true
23681
+
x-linode-filterable: true
23484
23682
IPAddressPrivate:
23485
23683
type: object
23486
23684
description: >
@@ -23551,7 +23749,7 @@ components:
23551
23749
IPAddressV6LinkLocal:
23552
23750
type: object
23553
23751
description: >
23554
-
A link-local IPv6 address that exists in Linode's system,.
23752
+
A link-local IPv6 address that exists in Linode's system.
23555
23753
properties:
23556
23754
address:
23557
23755
type: string
@@ -24445,6 +24643,8 @@ components:
24445
24643
* Setting the value to a specific public IPv4 address that is assigned to the Linode enables a 1:1 NAT between that address and the VPC Subnet IPv4 address.
24446
24644
* The public IPv4 address can't be shared with another Linode.
24447
24645
* If omitted, set to `null`, or set to an empty string (`""`), no 1:1 NAT is established.
24646
+
24647
+
**Note**: When creating a new compute-instance, you can't set this to a specific IPv4 address. When a new compute instance is created, the network establishes a public IPv4 address for it. Since this address doesn't exist yet, you can't include a custom IPv4 address to change it. Once your compute instances is created, you can [update your configuration profile interface](https://www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the `nat_1_1` address.
24448
24648
example: '203.0.113.2'
24449
24649
# ipv6:
24450
24650
# type: object
@@ -24474,7 +24674,7 @@ components:
24474
24674
type: array
24475
24675
nullable: true
24476
24676
description: |
24477
-
An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. **IPv6 ranges are also available to select participants in the Beta program.**
24677
+
An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
24478
24678
24479
24679
* Array items are only allowed for `vpc` type Interfaces.
24480
24680
* This must be empty for non-`vpc` type Interfaces.
0 commit comments