v57

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

Instance Type

Retrieve all Instance Types

Get all Instance Types 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/instance/type

Query parameters

siteIdstring uuid

Filter Instance Types by Site ID

infrastructureProviderIdstring uuid

Filter Instance Types by Infrastructure Provider ID.

tenantIdstring uuid

Filter Instance Types by Tenant ID.

statusstring

Filter Instance Types by Status

querystring

Search for matches across all Instance Types. Input will be matched against name, display name, description, labels, and status fields

includeRelation'InfrastructureProvider' | 'Site'

Related entity to expand

includeMachineAssignmentboolean

Include Machine assignments for each Instance Type. Can only be requested by Provider.

includeAllocationStatsboolean

Include Allocation stats.

excludeUnallocatedboolean

Excludes Instance Type records that have no allocations from being returned in the result set. Currently can only be requested by Tenant.

pageNumberinteger

Example:1

Page number for pagination query

pageSizeinteger

Example:20

Page size for pagination query

Ordering for pagination query

Response

idstring uuid

Unique UUID v4 identifier for the Instance Type

namestring

Name of the Instance Type

descriptionstring nullable

Description of the Instance Type

controllerMachineTypestring nullable

Machine type assigned by Site Controller

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider that owns the Instance Type

siteIdstring uuid

ID of the Site that owns the Instance Type

labelsLabels

status'Pending' | 'Registering' | 'Ready' | 'Deleting' | 'Error'

Status values for Instance Type objects

createdstring date-time

Date/time when the InstanceType was created

updatedstring date-time

Date/time when the InstanceType was last updated

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "x3.large",
    "description": "Part of X family, the X3 Large features increased compute power",
    "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    "labels": {
      "region": "portland",
      "env": "staging"
    },
    "machineCapabilities": [
      {
        "type": "CPU",
        "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
        "frequency": "3.0GHz",
        "cores": 18,
        "threads": 36,
        "count": 2
      }
    ],
    "machineInstanceTypes": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
        "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "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"
  }
]