Get a VPC subnet

get https://api.linode.com/{apiVersion}/vpcs/{vpcId}/subnets/{vpcSubnetId}

Get information about a single VPC Subnet.

CLI

linode-cli vpcs subnet-view $vpcId $vpcSubnetId

Learn more...

Responses

Response body

object

created

date-time

Filterable, Read-only The date-time of VPC Subnet creation.

integer

Filterable, Read-only The unique ID of the VPC Subnet.

ipv4

string

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.

label

string

length between 1 and 64

Filterable 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 (--).

linodes

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.

linodes

object

integer

ID of a Linode assigned to the VPC Subnet.

interfaces

array of objects

VPC purpose interfaces with the subnet's subnet_id assigned to the Linode.

interfaces

object

active

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.

config_id

integer | null

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.

integer

ID of the interface.

updated

date-time | null

Filterable, Read-only The date-time of the most recent VPC Subnet update.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/vpcs/vpcId/subnets/vpcSubnetId \
3
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "created": "2023-07-11T00:00:00",
3
  "id": 456,
4
  "ipv4": "10.0.1.0/24",
5
  "label": "cool-vpc-subnet",
6
  "linodes": [
7
    {
8
      "id": 111,
9
      "interfaces": [
10
        {
11
          "active": true,
12
          "config_id": 4567,
13
          "id": 421
14
        }
15
      ]
16
    }
17
  ],
18
  "updated": "2023-09-11T00:00:00"
19
}

200A VPC Subnet object.

defaultSee Errors for the range of possible error response codes.