Sign in

v57

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

Update Allocation

Update an existing Allocation

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. Provider must own the Allocation.

Tenant management of Allocation is not supported in MVP.

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

Request body

namestring nullable

Update name of the Allocation

descriptionstring nullable

Update description of the Allocation

Example request

{
  "name": "Echo Studios Compute",
  "description": "Echo Studios resource allocation in SJC4"
}

Response

OK

idstring uuid

ID of the Allocation

namestring

Concise and descriptive name of the Allocation

descriptionstring nullable

Detailed description of the Allocation

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider that created the Allocation

tenantIdstring uuid

ID of the Tenant that received the Allocation

siteIdstring uuid

ID of the Site where resources are allocated

status'Pending' | 'Registered' | 'Deleting' | 'Error'

Status values for Allocation objects

createdstring date-time

Date/time when the Allocation was created

updatedstring date-time

Date/time when the Allocation was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Echo Studios Allocations",
  "description": "Echo Studios resource allocation in SJC4",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "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",
  "allocationConstraints": [
    {
      "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,
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ]
}