Sign in
IP Block

Retrieve All Derived IP Blocks

Retrieve all child IP Blocks allocated to Tenants from a specific Provider super IP Block. When allocations are created from a super block, individual Tenant IP Blocks are created as a result.

The IP Block in the URL must be a root belonging to the organization's Infrastructure Provider. Records outside that scope return the same 404 response as an unknown ID.

User must have authorization role with PROVIDER_ADMIN suffix.

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

Query parameters

statusstring

Filter IP Blocks by Status

querystring

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

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

Related entity to expand

pageNumberinteger

One-indexed page number.

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"
  }
]

Changes

Changed in 4 of the 92 revisions of this API.421

  • f5fd051509361See the full diff
    • ○

      added the non-success response with the status 404

      response-non-success-status-added

  • 484497856a944See the full diff
    • ▲

      the items/usageStats/acquiredIPs response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the items/usageStats/acquiredPrefixes response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the items/usageStats/availableIPs response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

    • ▲

      the items/usageStats/availableSmallestPrefixes response's property type/format changed from integer/int64 to integer/uint64 for status 200

      response-property-type-changed

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • bc7cf73fe6041See the full diff
    • ●

      removed the optional property items/deprecations from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog