Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
IP Block

Retrieve all IP Blocks

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.

get/v2/org/{org}/nico/ipblock

Query parameters

infrastructureProviderIdstring uuid

Filter IP Blocks by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

tenantIdstring uuid

Filter IP Blocks by Tenant ID. Deprecated: Tenant is now inferred from the org's membership.

siteIdstring uuid

Filter IP Blocks by Site ID

statusstring

Filter IP Blocks by Status

includeUsageStatsboolean

Include IP Block usage stats in response

querystring

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

includeRelation'InfrastructureProvider' | 'Tenant' | 'Site'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'PREFIX_ASC' | 'PREFIX_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique UUID v4 identifier for the IP Block

namestring

Name of the IP Block

descriptionstring nullable

Description of the IP Block

siteIdstring uuid

ID of the Site

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider

tenantIdstring uuid nullable

ID of the Tenant

routingType'Public' | 'DatacenterOnly'

RoutingType of the IP Block

prefixstring

Either IPv4 or IPv6 address

prefixLengthinteger

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

protocolVersion'IPv4' | 'IPv6'

Version of the ip network IPv4 or IPv6

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

Status values for IP Block objects

createdstring date-time

Date/time when the Ip Block was created

updatedstring date-time

Date/time when the Ip Block was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Public Network Overlay for Site SJC4",
    "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    "tenantId": null,
    "routingType": "Public",
    "prefix": "202.168.16.0",
    "prefixLength": 20,
    "protocolVersion": "IPv4",
    "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"
  }
]