Skip to content

Commit 97d8537

Browse files
Merge pull request #930 from linode/release-4.174.0
Release 4.174.0
2 parents 49b08a3 + 50f22d6 commit 97d8537

File tree

1 file changed

+217
-17
lines changed

1 file changed

+217
-17
lines changed

openapi.yaml

Lines changed: 217 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.173.1
3+
version: 4.174.0
44
title: Linode API
55
license:
66
name: Apache 2.0
@@ -6613,7 +6613,7 @@ paths:
66136613
"subnet_id": 101,
66146614
"ipv4": {
66156615
"vpc": "10.0.1.2",
6616-
"nat_1_1": "203.0.113.2"
6616+
"nat_1_1": "add"
66176617
}
66186618
}
66196619
],
@@ -8248,7 +8248,9 @@ paths:
82488248
content:
82498249
application/json:
82508250
schema:
8251-
$ref: '#/components/schemas/Disk'
8251+
properties:
8252+
label:
8253+
$ref: '#/components/schemas/Disk/properties/label'
82528254
responses:
82538255
'200':
82548256
description: The updated Disk.
@@ -8550,8 +8552,10 @@ paths:
85508552
tags:
85518553
- Linode Instances
85528554
summary: Networking Information List
8553-
description: >
8555+
description: |
85548556
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.
85558559
operationId: getLinodeIPs
85568560
x-linode-cli-action: ips-list
85578561
security:
@@ -8593,20 +8597,27 @@ paths:
85938597
description: >
85948598
A list of private IP Address objects belonging to this Linode.
85958599
readOnly: true
8596-
shared:
8600+
vpc:
85978601
type: array
85988602
readOnly: true
85998603
items:
8600-
$ref: '#/components/schemas/IPAddress'
8604+
$ref: '#/components/schemas/IPAddressesVPCListResponse'
86018605
description: >
8602-
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.
86038607
reserved:
86048608
type: array
86058609
readOnly: true
86068610
items:
86078611
$ref: '#/components/schemas/IPAddress'
86088612
description: >
86098613
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.
86108621
ipv6:
86118622
type: object
86128623
description: >
@@ -19902,6 +19913,85 @@ paths:
1990219913
linode-cli vpcs update $vpcId \
1990319914
--description "A description of my VPC."
1990419915
--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.
19942+
content:
19943+
application/json:
19944+
schema:
19945+
$ref: '#/components/schemas/IPAddressesVPCListResponse'
19946+
default:
19947+
$ref: '#/components/responses/ErrorResponse'
19948+
x-code-samples:
19949+
- lang: Shell
19950+
source: >
19951+
curl -H "Authorization: Bearer $TOKEN" \
19952+
https://api.linode.com/v4/networking/vpcs/ips
19953+
- lang: CLI
19954+
source: >
19955+
linode-cli vpcs ip list
19956+
/vpcs/{vpcId}/ips:
19957+
parameters:
19958+
- $ref: '#/components/parameters/vpcId'
19959+
get:
19960+
tags:
19961+
- VPCs
19962+
summary: VPC IP Addresses View
19963+
servers:
19964+
- url: https://api.linode.com/v4
19965+
parameters:
19966+
- $ref: '#/components/parameters/pageOffset'
19967+
- $ref: '#/components/parameters/pageSize'
19968+
description: |
19969+
Returns a paginated list of IP addresses for a single VPC.
19970+
operationId: getVPCIPs
19971+
x-linode-cli-action:
19972+
- ip-list
19973+
- ip-ls
19974+
security:
19975+
- personalAccessToken: []
19976+
- oauth:
19977+
- ips:read_only
19978+
responses:
19979+
'200':
19980+
description: The IP addresses for the requested VPC.
19981+
content:
19982+
application/json:
19983+
schema:
19984+
$ref: '#/components/schemas/IPAddressesVPCListResponse'
19985+
default:
19986+
$ref: '#/components/responses/ErrorResponse'
19987+
x-code-samples:
19988+
- lang: Shell
19989+
source: >
19990+
curl -H "Authorization: Bearer $TOKEN" \
19991+
https://api.linode.com/v4/vpcs/123/ips
19992+
- lang: CLI
19993+
source: >
19994+
linode-cli vpcs ip-list 123
1990519995
/vpcs/{vpcId}/subnets:
1990619996
x-linode-cli-command: vpcs
1990719997
parameters:
@@ -21800,7 +21890,7 @@ components:
2180021890
The interval, in seconds, at which a failed refresh should be retried.
2180121891

2180221892
* Valid values are
21803-
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
21893+
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
2180421894

2180521895
* Any other value is rounded up to the nearest valid value.
2180621896

@@ -21832,7 +21922,7 @@ components:
2183221922
authoritative.
2183321923

2183421924
* Valid values are
21835-
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
21925+
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
2183621926

2183721927
* Any other value is rounded up to the nearest valid value.
2183821928

@@ -21845,7 +21935,7 @@ components:
2184521935
The amount of time in seconds before this Domain should be refreshed.
2184621936

2184721937
* Valid values are
21848-
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
21938+
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
2184921939

2185021940
* Any other value is rounded up to the nearest valid value.
2185121941

@@ -21859,7 +21949,7 @@ components:
2185921949
records may be cached by resolvers or other domain servers.
2186021950

2186121951
* Valid values are
21862-
0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
21952+
0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
2186321953

2186421954
* Any other value is rounded up to the nearest valid value.
2186521955

@@ -23000,21 +23090,23 @@ components:
2300023090
format: date-time
2300123091
nullable: true
2300223092
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.
2300423094
example: null
2300523095
readOnly: true
2300623096
eol:
2300723097
type: string
2300823098
format: date-time
23099+
nullable: true
2300923100
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.
2301123102
example: '2026-07-01T04:00:00'
2301223103
readOnly: true
2301323104
vendor:
2301423105
x-linode-filterable: true
2301523106
type: string
23107+
nullable: true
2301623108
description: >
23017-
The upstream distribution vendor. `None` for private Images.
23109+
The upstream distribution vendor. `null` for private Images.
2301823110
example: Debian
2301923111
readOnly: true
2302023112
x-linode-cli-display: 3
@@ -23454,7 +23546,6 @@ components:
2345423546
format: ipv4
2345523547
description: |
2345623548
The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
23457-
example: 192.0.2.1
2345823549
IPAddressesShareRequest:
2345923550
type: object
2346023551
description: A request object IP Addresses Share (POST /networking/ips/share)
@@ -23481,6 +23572,113 @@ components:
2348123572
* Can include both private and public IPv4 addresses.
2348223573
* You must have access to all of these addresses and they must be in the same Region as the primary Linode.
2348323574
* 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
2348423682
IPAddressPrivate:
2348523683
type: object
2348623684
description: >
@@ -23551,7 +23749,7 @@ components:
2355123749
IPAddressV6LinkLocal:
2355223750
type: object
2355323751
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.
2355523753
properties:
2355623754
address:
2355723755
type: string
@@ -24445,6 +24643,8 @@ components:
2444524643
* 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.
2444624644
* The public IPv4 address can't be shared with another Linode.
2444724645
* 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.
2444824648
example: '203.0.113.2'
2444924649
# ipv6:
2445024650
# type: object
@@ -24474,7 +24674,7 @@ components:
2447424674
type: array
2447524675
nullable: true
2447624676
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.
2447824678

2447924679
* Array items are only allowed for `vpc` type Interfaces.
2448024680
* This must be empty for non-`vpc` type Interfaces.

0 commit comments

Comments
 (0)