Retrieve an Instance Type

GET

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

GET

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

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

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

Get an Instance Type by ID.

If the org has an Infrastructure Provider entity that owns the Instance Type, then the Instance Type detail is returned. User must have authorization role with PROVIDER_ADMIN suffix.

If the org has a Tenant entity and it has a Tenant Account with the Infrastructure Provider of the Instance Type, then the Instance Type detail is returned. User must have authorization role with TENANT_ADMIN suffix.

Get an Instance Type by ID. If the org has an Infrastructure Provider entity that owns the Instance Type, then the Instance Type detail is returned. User must have authorization role with `PROVIDER_ADMIN` suffix. If the org has a Tenant entity and it has a Tenant Account with the Infrastructure Provider of the Instance Type, then the Instance Type detail is returned. User must have authorization role with `TENANT_ADMIN` suffix.

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

instanceTypeIdstringRequiredformat: "uuid"

ID of the Instance Type

Query parameters

includeMachineAssociationbooleanOptional

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

includeAllocationStatsbooleanOptional

Include Allocation stats. Currently can only be requested by Tenant

includeRelationenumOptional

Related entity to expand

Allowed values:

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