Sign in
Subnet

Retrieve all Subnets

Retrieve all Subnets for the org

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

get/v2/org/{org}/nico/subnet

Query parameters

siteIdstring uuid

Filter subnets by Site, required if vpcId query param is not specified

vpcIdstring uuid

Filter subnets by VPC

statusstring

Filter Subnets by Status

querystring

Search for matches across all Sites. Input will be matched against name, description and status fields

includeRelation'VPC' | 'Tenant' | 'IPv4Block' | 'IPv6Block'

Related entity to expand

includeUsageStatsboolean

When true, each Subnet object includes usage statistic using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnets consumes a single IP. In addition, 1 gateway and 1 broadcast IP address is reserved per Subnet.

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid
namestring
descriptionstring nullable
siteIdstring uuid
vpcIdstring uuid
tenantIdstring uuid
controllerNetworkSegmentIdstring uuid nullable
ipv4Prefixstring ipv4 nullable

The prefix that gets assigned to the subnet if ipv4 block is chosen

ipv4BlockIdstring uuid nullable
ipv4Gatewaystring ipv4 nullable
ipv6Prefixstring ipv6 nullable
ipv6BlockIdstring uuid nullable
ipv6Gatewaystring ipv6 nullable
mtuinteger

Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

prefixLengthinteger

Max value depends on prefix length of parent IP Block

routingType'Public' | 'DatacenterOnly' nullable
status'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for Subnet objects

createdstring date-time
updatedstring date-time

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "spark-gpu-net",
    "description": "Subnet for GPU nodes",
    "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "controllerNetworkSegmentId": "abe7b0e8-67db-4e89-903e-fc4f2bd7f034",
    "ipv4Prefix": "204.168.0.250",
    "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    "ipv4Gateway": "204.168.0.1",
    "ipv6Prefix": null,
    "ipv6BlockId": null,
    "ipv6Gateway": null,
    "prefixLength": 20,
    "routingType": "Public",
    "status": "Pending",
    "statusHistory": [
      {
        "status": "Pending",
        "message": "Request received, pending processing",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes