Retrieve all Instance Types

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/instance/type

GET

/v2/org/:org/nico/instance/type

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance/type \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "name": "x3.large",
5     "description": "Part of X family, the X3 Large features increased compute power",
6     "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
7     "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
8     "machineCapabilities": [
9       {
10         "type": "CPU",
11         "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
12         "frequency": "3.0GHz",
13         "cores": 18,
14         "threads": 36,
15         "count": 2
16       }
17     ],
18     "status": "Pending",
19     "statusHistory": [
20       {
21         "status": "Pending",
22         "message": "Request received, pending processing",
23         "created": "2019-08-24T14:15:22Z",
24         "updated": "2019-08-24T14:15:22Z"
25       }
26     ],
27     "deprecations": [
28       {
29         "queryParam": "includeMachineAssociation",
30         "replacedBy": "includeMachineAssignment",
31         "takeActionBy": "2023-07-26T00:00:00Z",
32         "notice": "'includeMachineAssociation' has been deprecated in favor of 'includeMachineAssignment'. Please take action immediately."
33       },
34       {
35         "attribute": "displayName",
36         "takeActionBy": "2024-10-30T00:00:00Z",
37         "notice": "'displayName' has been deprecated. Please take action immediately."
38       }
39     ],
40     "created": "2019-08-24T14:15:22Z",
41     "updated": "2019-08-24T14:15:22Z"
42   }
43 ]

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.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringOptionalformat: "uuid"

Filter Instance Types by Site ID

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

Filter Instance Types by Infrastructure Provider ID.

tenantIdstringOptionalformat: "uuid"Deprecated

Filter Instance Types by Tenant ID.

statusstringOptional

Filter Instance Types by Status

querystringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

includeMachineAssignmentbooleanOptional

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

includeAllocationStatsbooleanOptional

Include Allocation stats.

excludeUnallocatedbooleanOptional

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

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Instance Type

namestring2-256 characters

Name of the Instance Type

descriptionstring or null

Description of the Instance Type

controllerMachineTypestring or null

Machine type assigned by Site Controller

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that owns the Instance Type

siteIdstringformat: "uuid"

ID of the Site that owns the Instance Type

labelsmap from strings to strings

User-defined key-value labels for the Instance Type

machineCapabilitieslist of objects

List of capabilities that are supported by the Machine's of this Instance Type

machineInstanceTypeslist of objects

Available only for Providers

allocationStatsobject

summary of machine counts by allocation status

statusenum

Status of the Instance Type

statusHistorylist of objects

Chronological status history for the Instance Type

deprecationslist of objects

Deprecation notices for fields returned by this resource

createddatetimeRead-only

Date/time when the InstanceType was created

updateddatetimeRead-only

Date/time when the InstanceType was last updated

Errors

403

Forbidden Error