VPCs
v4.176.0 VPCs List GET
https://api.linode.com/v4/vpcs
Display all VPCs on your account.
Authorizations Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs \
"Authorization: Bearer $TOKEN "
Response Samples
200
default
{
"data" : [
{
"created" : "2023-07-11T00:00:00" ,
"description" : "A description of my VPC." ,
"id" : 123 ,
"label" : "cool-vpc" ,
"region" : "us-east" ,
"subnets" : [
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of VPC objects.
array
of objects
string<date-time>
The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
The unique ID of the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). string
The Region for the VPC.
array
of objects
A list of subnets associated with the VPC.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
string<date-time>
The date-time of the most recent VPC update.
integer
The current
page .
integer
The total number of
pages .
integer
The total number of results.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Create POST
https://api.linode.com/v4/vpcs
Create a new VPC and optionally associated VPC Subnets.
Users must have the add_vpc grant to access this command. A successful request triggers a vpc_create event and subnet_create events for any created VPC Subnets. Once a VPC is created, it can be attached to a Linode by assigning a VPC Subnet to one of the Linode’s Configuration Profile Interfaces. This step can be accomplished with the following commands:
Authorizations personalAccessToken oauth vpc:read_write
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs \
"Authorization: Bearer $TOKEN " \
"Content-Type: application/json" \
'{
"description": "A description of my VPC.",
"label": "cool-vpc",
"region": "us-east",
"subnets": [
{
"label": "cool-vpc-subnet",
"ipv4": "10.0.1.0/24"
}
]
}'
linode-cli vpcs create \
"A description of my VPC." \
\
\
\
Request Body Schema string
<=
255
characters
A written description to help distinguish the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). string
The Region for the VPC.
array
of objects
A list of subnets associated with the VPC.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--).
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"description" : "A description of my VPC." ,
"id" : 123 ,
"label" : "cool-vpc" ,
"region" : "us-east" ,
"subnets" : [
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The new VPC.
string<date-time>
The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
The unique ID of the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). string
The Region for the VPC.
array
of objects
A list of subnets associated with the VPC.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
string<date-time>
The date-time of the most recent VPC update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC IP Addresses List GET
https://api.linode.com/v4/vpcs/ips
Returns a paginated list of all VPC IP addresses and address ranges on your account.
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.
Authorizations personalAccessToken oauth ips:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"active" : true ,
"address" : "192.0.2.141" ,
"address_range" : null ,
"config_id" : 4567 ,
"gateway" : "192.0.2.1" ,
"interface_id" : 2435 ,
"linode_id" : 123 ,
"nat_1_1" : "192.168.0.42" ,
"page" : 1 ,
"pages" : 1 ,
"prefix" : 24 ,
"region" : "us-east" ,
"results" : 1 ,
"subnet_id" : 101 ,
"subnet_mask" : "255.255.255.0" ,
"vpc_id" : 7654
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of VPC interface IP addresses.
array
boolean
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.
string<ip>
An IPv4 address configured for this VPC interface. These follow the RFC 1918 private address format. Displayed as null if an address_range.
string
A range of IPv4 addresses configured for this VPC interface. Displayed as null if a single address.
integer
The globally general entity identifier for the Linode configuration profile where the VPC is included.
string<ip>
The default gateway for the VPC subnet that the IP or IP range belongs to.
integer
The globally general API entity identifier for the Linode interface.
integer
The identifier for the Linode the VPC interface currently belongs to.
string<ip>
The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn’t used.
integer
The current
page .
integer
The total number of
pages .
integer
The number of bits set in the subnet_mask.
string
The region of the VPC.
integer
The total number of results.
integer
The id of the VPC Subnet for this interface.
string<ip>
The mask that separates host bits from network bits for the address or address_range.
integer
The unique globally general API entity identifier for the VPC.
integer
The current
page .
integer
The total number of
pages .
integer
The total number of results.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Delete DELETE
https://api.linode.com/v4/vpcs/{vpcId}
Delete a single VPC and all of its Subnets.
The User accessing this command must have read_write grants to the VPC. A successful request triggers a vpc_delete event and subnet_delete events for each deleted VPC Subnet. All of the VPC’s Subnets must be eligible for deletion. Accordingly, all Configuration Profile Interfaces that each Subnet is assigned to must first be deleted. If those Interfaces are active, the associated Linodes must first be shut down before they can be removed. If any Subnet cannot be deleted, then neither the VPC nor any of its Subnets are deleted. Authorizations personalAccessToken oauth vpc:read_write
Path Parameters vpcId integer
Required The id of the VPC.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId \
"Authorization: Bearer $TOKEN " \
linode-cli vpcs delete $vpcId
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Delete request successful.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC View GET
https://api.linode.com/v4/vpcs/{vpcId}
Get information about a single VPC.
Authorizations Path Parameters vpcId integer
Required The id of the VPC.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId \
"Authorization: Bearer $TOKEN "
linode-cli vpcs view $vpcId
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"description" : "A description of my VPC." ,
"id" : 123 ,
"label" : "cool-vpc" ,
"region" : "us-east" ,
"subnets" : [
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A VPC object.
string<date-time>
The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
The unique ID of the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). string
The Region for the VPC.
array
of objects
A list of subnets associated with the VPC.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
string<date-time>
The date-time of the most recent VPC update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Update PUT
https://api.linode.com/v4/vpcs/{vpcId}
Update an existing VPC.
The User accessing this command must have read_write grants to the VPC. A successful request triggers a vpc_update event. To update a VPC’s Subnet, use the VPC Subnet Update command.
Authorizations personalAccessToken oauth vpc:read_write
Path Parameters vpcId integer
Required The id of the VPC.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId \
"Authorization: Bearer $TOKEN " \
"Content-Type: application/json" \
'{
"description": "A description of my VPC.",
"label": "cool-vpc"
}'
linode-cli vpcs update $vpcId \
"A description of my VPC."
--label cool-vpc
Request Body Schema string
<=
255
characters
A written description to help distinguish the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--).
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"description" : "A description of my VPC." ,
"id" : 123 ,
"label" : "cool-vpc" ,
"region" : "us-east" ,
"subnets" : [
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated VPC.
string<date-time>
The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
The unique ID of the VPC.
string
1..64
characters
The VPC’s label, for display purposes only.
Needs to be unique among the Account’s VPCs. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). string
The Region for the VPC.
array
of objects
A list of subnets associated with the VPC.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
string<date-time>
The date-time of the most recent VPC update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC IP Addresses View GET
https://api.linode.com/v4/vpcs/{vpcId}/ips
Returns a paginated list of IP addresses for a single VPC.
Authorizations personalAccessToken oauth ips:read_only
Path Parameters vpcId integer
Required The id of the VPC.
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli vpcs ip-list 123
Response Samples
200
default
{
"active" : true ,
"address" : "192.0.2.141" ,
"address_range" : null ,
"config_id" : 4567 ,
"gateway" : "192.0.2.1" ,
"interface_id" : 2435 ,
"linode_id" : 123 ,
"nat_1_1" : "192.168.0.42" ,
"page" : 1 ,
"pages" : 1 ,
"prefix" : 24 ,
"region" : "us-east" ,
"results" : 1 ,
"subnet_id" : 101 ,
"subnet_mask" : "255.255.255.0" ,
"vpc_id" : 7654
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The IP addresses for the requested VPC.
boolean
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.
string<ip>
An IPv4 address configured for this VPC interface. These follow the RFC 1918 private address format. Displayed as null if an address_range.
string
A range of IPv4 addresses configured for this VPC interface. Displayed as null if a single address.
integer
The globally general entity identifier for the Linode configuration profile where the VPC is included.
string<ip>
The default gateway for the VPC subnet that the IP or IP range belongs to.
integer
The globally general API entity identifier for the Linode interface.
integer
The identifier for the Linode the VPC interface currently belongs to.
string<ip>
The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn’t used.
integer
The current
page .
integer
The total number of
pages .
integer
The number of bits set in the subnet_mask.
string
The region of the VPC.
integer
The total number of results.
integer
The id of the VPC Subnet for this interface.
string<ip>
The mask that separates host bits from network bits for the address or address_range.
integer
The unique globally general API entity identifier for the VPC.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Subnets List GET
https://api.linode.com/v4/vpcs/{vpcId}/subnets
Get information about all VPC Subnets associated with a VPC.
Authorizations Path Parameters vpcId integer
Required The id of the VPC.
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId /subnets \
"Authorization: Bearer $TOKEN "
linode-cli vpcs subnets-list $vpcId
Response Samples
200
default
{
"data" : [
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of VPC Subnet objects.
array
of objects
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
integer
The current
page .
integer
The total number of
pages .
integer
The total number of results.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Subnet Create POST
https://api.linode.com/v4/vpcs/{vpcId}/subnets
Create a VPC Subnet.
The User accessing this command must have read_write grants to the VPC. A successful request triggers a subnet_create event. Once a VPC Subnet is created, it can be attached to a Linode by assigning the Subnet to one of the Linode’s Configuration Profile Interfaces. This step can be accomplished with the following commands:
Authorizations personalAccessToken oauth vpc:read_write
Path Parameters vpcId integer
Required The id of the VPC.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId /subnets \
"Authorization: Bearer $TOKEN " \
"Content-Type: application/json" \
'{
"label": "cool-vpc-subnet",
"ipv4": "10.0.1.0/24",
}'
linode-cli vpcs subnet-create $vpcId \
\
Request Body Schema string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--).
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The new VPC Subnet.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Subnet Delete DELETE
https://api.linode.com/v4/vpcs/{vpcId}/subnets/{vpcSubnetId}
Delete a single VPC Subnet.
The user accessing this command must have read_write grants to the VPC. A successful request triggers a subnet_delete event.
Note: You need to delete all the Configuration Profile Interfaces that this Subnet is assigned to before you can delete it. If those Interfaces are active, the associated Linode needs to be shut down before they can be removed.
Authorizations personalAccessToken oauth vpc:read_write
Path Parameters vpcId integer
Required The id of the VPC.
vpcSubnetId integer
Required The id of the VPC Subnet.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId /subnets/$vpcSubnetId \
"Authorization: Bearer $TOKEN " \
linode-cli vpcs subnet-delete $vpcId $vpcSubnetId
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Delete request successful.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Subnet View GET
https://api.linode.com/v4/vpcs/{vpcId}/subnets/{vpcSubnetId}
Get information about a single VPC Subnet.
Authorizations Path Parameters vpcId integer
Required The id of the VPC.
vpcSubnetId integer
Required The id of the VPC Subnet.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId /subnets/$vpcSubnetId \
"Authorization: Bearer $TOKEN "
linode-cli vpcs subnet-view $vpcId #vpcSubnetId
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A VPC Subnet object.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
VPC Subnet Update PUT
https://api.linode.com/v4/vpcs/{vpcId}/subnets/{vpcSubnetId}
Update a VPC Subnet.
The User accessing this command must have read_write grants to the VPC. A successful request triggers a subnet_update event. Authorizations personalAccessToken oauth vpc:read_write
Path Parameters vpcId integer
Required The id of the VPC.
vpcSubnetId integer
Required The id of the VPC Subnet.
Request Samples
Shell
CLI
curl https://api.linode.com/v4/vpcs/$vpcId /subnets/$vpcSubnetId \
"Authorization: Bearer $TOKEN " \
"Content-Type: application/json" \
'{
"label": "cool-vpc-subnet"
}'
linode-cli vpcs subnet-update $vpcId \
Request Body Schema string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--).
Response Samples
200
default
{
"created" : "2023-07-11T00:00:00" ,
"id" : 456 ,
"ipv4" : "10.0.1.0/24" ,
"label" : "cool-vpc-subnet" ,
"linodes" : [
{
"id" : 111 ,
"interfaces" : [
{
"active" : true ,
"id" : 421
}
]
}
],
"updated" : "2023-09-11T00:00:00"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The updated VPC Subnet.
string<date-time>
The date-time of VPC Subnet creation.
integer
The unique ID of the VPC Subnet.
string<ip>
IPv4 range in CIDR canonical form.
The range must belong to a private address space as defined in RFC1918 . Allowed prefix lengths: 1-29. The range must not overlap with 192.168.128.0/17. The range must not overlap with other Subnets on the same VPC. string
1..64
characters
The VPC Subnet’s label, for display purposes only.
Must be unique among the VPC’s Subnets. Can only contain ASCII letters, numbers, and hyphens (-). You can’t use two consecutive hyphens (--). array
of objects
An array of Linode IDs assigned to the VPC Subnet.
A Linode is assigned to a VPC Subnet if it has a Configuration Profile with a vpc purpose interface with the subnet’s subnet_id. Even if the Configuration Profile is not active, meaning the Linode does not have access to the Subnet, the Linode still appears in this array.
integer
ID of a Linode assigned to the VPC Subnet.
array
of objects
An array of Interfaces assigned to the Linode.
boolean
Returns true if the Interface is in use, meaning that the Linode was powered on using the Configuration Profile to which the Interface belongs. Otherwise returns false.
integer
ID of the interface
string<date-time>
The date-time of the most recent VPC Subnet update.
Error
array
of objects
string
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.
string
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 or perform some other action before you can complete the request successfully.
