Sign in

v57

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

Retrieve all Allocations

Retrieve all Allocations for the org.

The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

Results are returned from both Provider and Tenant perspectives when the org has both roles.

get/v2/org/{org}/nico/allocation

Query parameters

infrastructureProviderIdstring uuid

Filter Allocations by Infrastructure Provider ID.

tenantIdstring uuid

Filter Allocations by Tenant ID.

siteIdstring uuid

Filter Allocations by Site ID. Can be specified multiple times to filter on more than one Site ID.

idstring

Filter Allocations by ID. Can be specified multiple times to filter on more than one ID.

resourceType'InstanceType' | 'IPBlock'

Filter Allocations by Constraint Resource Type. Can be specified multiple times to filter on more than one Constraint Resource Type.

statusstring

Filter Allocations by Status. Can be specified multiple times to filter on more than one Status.

resourceTypeIdstring

Filter Allocations by Constraint Resource Type ID. Can be specified multiple times to filter on more than one Constraint Resource Type ID.

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

Filter Allocations by Constraint Type. Can be specified multiple times to filter on more than one Constraint Type.

constraintValueinteger

Filter Allocations by Constraint Value. Can be specified multiple times to filter on more than one Constraint Value.

querystring

Search for matches across all Allocations. 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' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC' | 'SITE_NAME_ASC' | 'SITE_NAME_DESC' | 'TENANT_ORG_DISPLAY_NAME_ASC' | 'TENANT_ORG_DISPLAY_NAME_DESC' | 'INSTANCE_TYPE_NAME_ASC' | 'INSTANCE_TYPE_NAME_DESC' | 'IP_BLOCK_NAME_ASC' | 'IP_BLOCK_NAME_DESC' | 'CONSTRAINT_VALUE_ASC' | 'CONSTRAINT_VALUE_DESC'

Ordering for pagination query

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