Sign in

v57

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

Update Allocation Constraint

Update an existing Allocation Constraint by ID

Org must have an Infrastructure Provider. Specified Allocation must have been created by the Provider and requesting user must have PROVIDER_ADMIN role.

Modifying allocations may not be possible if Tenant has started utilizing resources from this allocation.

For an InstanceType resource, constraintValue can be incremented at any time, but not decremented if doing so requires decommissioning Tenant resources.

For an IPBlock resource, constraintValue cannot be modified if Tenant resources, e.g., Subnets or VPC Prefixes, reference the block.

patch/v2/org/{org}/nico/allocation/{allocationId}/constraint/{allocationConstraintId}

Request body

constraintValueinteger required

Value of the Allocation Constraint. For InstanceType, this value represents number of Machines allocated for Tenant. For IPBlock, this value represents the prefix Length of the IP Block.

Example request

{
  "constraintValue": 10
}

Response

OK

idstring uuid

ID of the Allocation Constraint

allocationIdstring uuid

ID of the Allocation that contains the Allocation Constraint

resourceType'InstanceType' | 'IPBlock'

Type of the Resource that the Allocation Constraint applies to

resourceTypeIdstring uuid

ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

constraintType'Reserved' | 'OnDemand' | 'Preemptible'

Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

constraintValueinteger

Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

derivedResourceIdstring nullable

ID of the allocated Tenant IP Block when resource type is IPBlock

createdstring date-time

Date/time when the Allocation Constraint was created

updatedstring date-time

Date/time when the Allocation Constraint was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
  "resourceType": "InstanceType",
  "resourceTypeId": "a59ee688-b5e5-4606-9891-f4a605edacd3",
  "constraintType": "Reserved",
  "constraintValue": 10,
  "derivedResourceId": null,
  "instanceType": {
    "name": "x3.large",
    "infrastructureProviderId": "63c29416-8833-4eaf-9e1c-7c0173cc3150",
    "siteId": "c9f4f276-6f7a-4209-953c-2b9870ce7cc1",
    "status": "Ready"
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}