---
title: "Retrieve Subnet"
method: GET
path: "/v2/org/{org}/nico/subnet/{subnetId}"
tags: ["Subnet"]
---

# Retrieve Subnet

`GET /v2/org/{org}/nico/subnet/{subnetId}`

Retrieve a specific Subnet

Org must have a Tenant entity. User must have authorization role with `TENANT_ADMIN` suffix.

## Query parameters

- `includeRelation` 'VPC' | 'Tenant' | 'IPv4Block' | 'IPv6Block'
- `includeUsageStats` boolean

## Response `200`

OK

- Subnet — Subnets are network grouping constructs for baremetal machines.
  - `id` string, uuid — Unique UUID v4 identifier for the Subnet
  - `name` string — Name of the Subnet
  - `description` string, nullable — Description of the Subnet
  - `siteId` string, uuid — ID of the Site containing the Subnet
  - `vpcId` string, uuid — ID of the VPC containing the Subnet
  - `controllerNetworkSegmentId` string, uuid, nullable — ID of the Site Controller network segment corresponding to the Subnet
  - `ipv4Prefix` string, ipv4, nullable — The prefix that gets assigned to the subnet if ipv4 block is chosen
  - `ipv4BlockId` string, uuid, nullable — ID of the derived Tenant IPv4 Block from an Allocation
  - `ipv4Gateway` string, ipv4, nullable — Address of the IPv4 gateway in the Subnet
  - `ipv6Prefix` string, ipv6, nullable — Prefix of the network in CIDR notation
  - `ipv6BlockId` string, uuid, nullable — ID of the derived Tenant IPv6 Block from an Allocation
  - `ipv6Gateway` string, ipv6, nullable — Address of the IPv6 gateway in the Subnet
  - `mtu` integer — Maximum Transmission Unit size in bytes. This property is system-determined and read-only.
  - `prefixLength` integer — Max value depends on prefix length of parent IP Block
  - `routingType` 'Public' | 'DatacenterOnly', nullable — Routing type of the Subnet
  - `status` 'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error' — Status values for Subnet objects
  - `usageStats` IpBlockUsageStats — Usage statistics for an IP Block, VPC Prefix or Subnet
    - `availableIPs` integer — Total number of IP addresses in the block (acquired and unused)
    - `acquiredIPs` integer — Number of individual IP addresses acquired from the block
    - `availablePrefixes` string[] — Example prefixes available to acquire
    - `availableSmallestPrefixes` integer — Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)
    - `acquiredPrefixes` integer — Total number of prefixes (of any size) acquired from this block
  - `statusHistory` StatusDetail[] — Chronological status history for the Subnet
    - `status` string — State of the associated entity at a particular time
    - `message` string, nullable — Description of the state and cause/remedy in case of error
    - `created` string, date-time — Date/time when the associated entity assumed the status
    - `updated` string, date-time — Date/time when the associated entity was last observed with this status
  - `created` string, date-time — Date/time when the Subnet was created
  - `updated` string, date-time — Date/time when the Subnet was last updated

## Other responses

- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects

---

[API](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/versions/69e00804e732/schema)