Retrieve IP Block

GET

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

GET

/v2/org/:org/nico/ipblock/:ipBlockId

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

1 {
2   "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3   "name": "Public Network Overlay for Site SJC4",
4   "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable",
5   "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
6   "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
7   "tenantId": null,
8   "routingType": "Public",
9   "prefix": "192.168.20.0",
10   "prefixLength": 24,
11   "protocolVersion": "IPv4",
12   "usageStats": {
13     "availableIPs": 256,
14     "acquiredIPs": 2,
15     "availablePrefixes": [
16       "192.168.20.32/27",
17       "192.168.20.64/26",
18       "192.168.20.128/25"
19     ],
20     "availableSmallestPrefixes": 56,
21     "acquiredPrefixes": 1
22   },
23   "status": "Pending",
24   "statusHistory": [
25     {
26       "status": "Pending",
27       "message": "Request received, pending processing",
28       "created": "2019-08-24T14:15:22Z",
29       "updated": "2019-08-24T14:15:22Z"
30     }
31   ],
32   "created": "2019-08-24T14:15:22Z",
33   "updated": "2019-08-24T14:15:22Z"
34 }

Retrieve an IP Block by ID.

User must have authorization role with PROVIDER_ADMIN or 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

ipBlockIdstringRequired

ID of the IP Block

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"

Filter IP Blocks by Infrastructure Provider ID

tenantIdstringOptionalformat: "uuid"

Filter IP Blocks by Tenant ID

includeUsageStatsbooleanOptional

Include IP Block usage stats in response

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the IP Block

namestring2-256 characters

Name of the IP Block

descriptionstring or null

Description of the IP Block

siteIdstringformat: "uuid"

ID of the Site

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider

tenantIdstring or nullformat: "uuid"

ID of the Tenant

routingTypeenum

RoutingType of the IP Block

prefixstring

Either IPv4 or IPv6 address

prefixLengthinteger

Min: 1, Max: 32 for ipv4, 128 for ipv6

protocolVersionenum

Version of the ip network IPv4 or IPv6

usageStatsobject

Usage summary from IPAM for the IP Block

statusenum

Status of the IP Block

statusHistorylist of objects

Chronological status history for the IP Block

createddatetimeRead-only

Date/time when the Ip Block was created

updateddatetimeRead-only

Date/time when the Ip Block was last updated

Errors

403

Forbidden Error