Sign in
Subnet

Retrieve Subnet

Retrieve a specific Subnet

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

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

Query parameters

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

Related entity to expand

includeUsageStatsboolean

When true, each Subnet object includes usage statistics 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 Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

Response

OK

idstring uuid

Unique UUID v4 identifier for the Subnet

namestring

Name of the Subnet

descriptionstring nullable

Description of the Subnet

siteIdstring uuid

ID of the Site containing the Subnet

vpcIdstring uuid

ID of the VPC containing the Subnet

controllerNetworkSegmentIdstring uuid nullable

ID of the Site Controller network segment corresponding to the Subnet

ipv4Prefixstring ipv4 nullable

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

ipv4BlockIdstring uuid nullable

ID of the derived Tenant IPv4 Block from an Allocation

ipv4Gatewaystring ipv4 nullable

Address of the IPv4 gateway in the Subnet

ipv6Prefixstring ipv6 nullable

Prefix of the network in CIDR notation

ipv6BlockIdstring uuid nullable

ID of the derived Tenant IPv6 Block from an Allocation

ipv6Gatewaystring ipv6 nullable

Address of the IPv6 gateway in the Subnet

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

Routing type of the Subnet

status'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error'

Status values for Subnet objects

createdstring date-time

Date/time when the Subnet was created

updatedstring date-time

Date/time when the Subnet was last updated

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",
  "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

Changed in 5 of the 92 revisions of this API.444

  • 484497856a944See the full diff
    • ▲

      the usageStats/acquiredIPs response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the usageStats/acquiredPrefixes response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the usageStats/availableIPs response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the usageStats/availableSmallestPrefixes response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

  • bc7cf73fe6042See the full diff
    • ●

      removed the optional property deprecations from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property tenantId from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b078e63260c12See the full diff
    • ○

      added the new optional query request parameter includeUsageStats

      new-optional-request-parameter

    • ○

      added the optional property usageStats to the response with the 200 status

      response-optional-property-added

  • ffa0635230582See the full diff
    • ●

      deleted the query request parameter includeUsageStats

      request-parameter-removed

    • ●

      removed the optional property usageStats from the response with the 200 status

      response-optional-property-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f20872e0979a2See the full diff
    • ○

      added the new optional query request parameter includeUsageStats

      new-optional-request-parameter

    • ○

      added the optional property usageStats to the response with the 200 status

      response-optional-property-added