Retrieve all Subnets

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/subnet

GET

/v2/org/:org/nico/subnet

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/subnet \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "name": "spark-gpu-net",
5     "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
6     "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
7     "controllerNetworkSegmentId": "abe7b0e8-67db-4e89-903e-fc4f2bd7f034",
8     "ipv4Prefix": "202.168.16.0",
9     "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
10     "ipv4Gateway": "202.168.0.1",
11     "ipv6Prefix": null,
12     "ipv6BlockId": null,
13     "ipv6Gateway": null,
14     "prefixLength": 20,
15     "routingType": "Public",
16     "status": "Ready",
17     "statusHistory": [
18       {
19         "status": "Ready",
20         "message": "Subnet has been successfully provisioned on Site",
21         "created": "2019-08-24T16:02:38Z",
22         "updated": "2019-08-24T16:02:38Z"
23       },
24       {
25         "status": "Pending",
26         "message": "Request received, pending processing",
27         "created": "2019-08-24T14:15:22Z",
28         "updated": "2019-08-24T14:15:22Z"
29       }
30     ],
31     "created": "2019-08-24T14:15:22Z",
32     "updated": "2019-08-24T14:15:22Z"
33   }
34 ]

Retrieve all Subnets for the org

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

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringOptionalformat: "uuid"

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

vpcIdstringOptionalformat: "uuid"

Filter subnets by VPC

statusstringOptional

Filter Subnets by Status

querystringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

includeUsageStatsbooleanOptional

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.

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Subnet

namestring2-256 characters

Name of the Subnet

descriptionstring or null

Description of the Subnet

siteIdstringformat: "uuid"

ID of the Site containing the Subnet

vpcIdstringformat: "uuid"

ID of the VPC containing the Subnet

controllerNetworkSegmentIdstring or nullformat: "uuid"

ID of the Site Controller network segment corresponding to the Subnet

ipv4Prefixstring or nullformat: "ipv4"

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

ipv4BlockIdstring or nullformat: "uuid"

ID of the derived Tenant IPv4 Block from an Allocation

ipv4Gatewaystring or nullformat: "ipv4"

Address of the IPv4 gateway in the Subnet

ipv6Prefixstring or nullformat: "ipv6"

Prefix of the network in CIDR notation

ipv6BlockIdstring or nullformat: "uuid"

ID of the derived Tenant IPv6 Block from an Allocation

ipv6Gatewaystring or nullformat: "ipv6"

Address of the IPv6 gateway in the Subnet

mtuintegerRead-only

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

routingTypeenum

Routing type of the Subnet

statusenum

Status of the Subnet

usageStatsobject

Present when query parameter includeUsageStats=true. 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.

statusHistorylist of objectsRead-only

Chronological status history for the Subnet

createddatetimeRead-only

Date/time when the Subnet was created

updateddatetimeRead-only

Date/time when the Subnet was last updated

Errors

403

Forbidden Error