Retrieve all IP Blocks

GET

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

GET

/v2/org/:org/nico/ipblock

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

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

Retrieve all IP blocks for the org.

User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix. infrastructureProviderId or tenantId query parameter may be required for older API versions.

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

infrastructureProviderIdstringOptionalformat: "uuid"

Filter IP Blocks by Infrastructure Provider ID

tenantIdstringOptionalformat: "uuid"

Filter IP Blocks by Tenant ID

siteIdstringOptionalformat: "uuid"

Filter IP Blocks by Site ID

statusstringOptional

Filter IP Blocks by Status

includeUsageStatsbooleanOptional

Include IP Block usage stats in response

querystringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

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