---
title: "Retrieve all IP Blocks"
method: GET
path: "/v2/org/{org}/nico/ipblock"
tags: ["IP Block"]
---

# Retrieve all IP Blocks

`GET /v2/org/{org}/nico/ipblock`

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.

## Query parameters

- `infrastructureProviderId` string, uuid
- `tenantId` string, uuid
- `siteId` string, uuid
- `status` string
- `includeUsageStats` boolean
- `query` string
- `includeRelation` 'InfrastructureProvider' | 'Tenant' | 'Site'
- `pageNumber` integer
- `pageSize` integer
- `orderBy` 'NAME_ASC' | 'NAME_DESC' | 'PREFIX_ASC' | 'PREFIX_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

## Response `200`

OK

- IpBlock[]
  - `id` string, uuid — Unique UUID v4 identifier for the IP Block
  - `name` string — Name of the IP Block
  - `description` string, nullable — Description of the IP Block
  - `siteId` string, uuid — ID of the Site
  - `infrastructureProviderId` string, uuid — ID of the Infrastructure Provider
  - `tenantId` string, uuid, nullable — ID of the Tenant
  - `routingType` 'Public' | 'DatacenterOnly' — RoutingType of the IP Block
  - `prefix` string — Either IPv4 or IPv6 address
  - `prefixLength` integer — Min: 1, Max: 32 for ipv4, 128 for ipv6
  - `protocolVersion` 'IPv4' | 'IPv6' — Version of the ip network IPv4 or IPv6
  - `usageStats` IpBlockUsageStats — Usage statistics for an IP Block, VPC Prefix or Subnet
    - `availableIPs` integer — Total number of IP addresses in the block (acquired and unused)
    - `acquiredIPs` integer — Number of individual IP addresses acquired from the block
    - `availablePrefixes` string[] — Example prefixes available to acquire
    - `availableSmallestPrefixes` integer — Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)
    - `acquiredPrefixes` integer — Total number of prefixes (of any size) acquired from this block
  - `status` 'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error' — Status values for IP Block objects
  - `statusHistory` StatusDetail[] — Chronological status history for the IP Block
    - `status` string — State of the associated entity at a particular time
    - `message` string, nullable — Description of the state and cause/remedy in case of error
    - `created` string, date-time — Date/time when the associated entity assumed the status
    - `updated` string, date-time — Date/time when the associated entity was last observed with this status
  - `created` string, date-time — Date/time when the Ip Block was created
  - `updated` string, date-time — Date/time when the Ip Block was last updated

## Other responses

- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects

---

[API](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/4c29fe59bd4e/schema)