Sign in
IP Block

Update IP Block

Update an existing IP Block

Org must have an Infrastructure Provider. Specified IP Block must have been created by the Provider and requesting user must have PROVIDER_ADMIN role. Only root IP Blocks can be patched.

Tenant IP Blocks are managed via Allocation. Unknown IDs, IP Blocks belonging to another Infrastructure Provider, and SitePrefix records created for individual Tenants return 404.

patch/v2/org/{org}/nico/ipblock/{ipBlockId}

Request body

namestring nullable

Name of the IP Block

descriptionstring nullable

Description of the IP Block

Example request

{
  "name": "Public Network Overlay for Site SJC4",
  "description": "This is the primary IP overlay for SJC4. All IPs are publicly routable"
}

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 6 of the 90 revisions of this API.417

  • f5fd051509361See the full diff
    • ○

      added the non-success response with the status 404

      response-non-success-status-added

  • 484497856a944See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

  • bc7cf73fe6041See the full diff
    • ●

      removed the optional property 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

  • b078e63260c12See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

  • ffa0635230582See the full diff
    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

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

  • f20872e0979a2See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added