VPCs
v4.176.0 List VPCs 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>
Read-only The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
Read-only 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>
Read-only The date-time of VPC Subnet creation.
integer
Read-only 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
Read-only 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>
Read-only The date-time of the most recent VPC Subnet update.
string<date-time>
Read-only The date-time of the most recent VPC update.
integer
Read-only The current page .
integer
Read-only The total number of pages .
integer
Read-only 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.
Create a VPC 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 operation. 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 operations:
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>
Read-only The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
Read-only 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>
Read-only The date-time of VPC Subnet creation.
integer
Read-only 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
Read-only 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>
Read-only The date-time of the most recent VPC Subnet update.
string<date-time>
Read-only 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.
Delete a VPC DELETE
https://api.linode.com/v4/vpcs/{vpcId}
Delete a single VPC and all of its Subnets.
The User accessing this operation 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.
Get a VPC 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>
Read-only The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
Read-only 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>
Read-only The date-time of VPC Subnet creation.
integer
Read-only 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
Read-only 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>
Read-only The date-time of the most recent VPC Subnet update.
string<date-time>
Read-only 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.
Update a VPC PUT
https://api.linode.com/v4/vpcs/{vpcId}
Update an existing VPC.
The User accessing this operation must have read_write grants to the VPC. A successful request triggers a vpc_update event. To update a VPC’s Subnet, run the Update a VPC subnet operation.
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>
Read-only The date-time of VPC creation.
string
<=
255
characters
A written description to help distinguish the VPC.
integer
Read-only 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>
Read-only The date-time of VPC Subnet creation.
integer
Read-only 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
Read-only 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>
Read-only The date-time of the most recent VPC Subnet update.
string<date-time>
Read-only 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.
