Retrieve all Instances

GET

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

GET

/v2/org/:org/nico/instance

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

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "name": "spark-monitor-1",
5     "description": "Node for monitoring Spark",
6     "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
7     "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
8     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
9     "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
10     "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
11     "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
12     "operatingSystemId": "eaeb86ee-c435-444e-9e01-8346f67f194b",
13     "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e,",
14     "networkSecurityGroupPropagationDetails": {
15       "detailedStatus": "Partial",
16       "status": "Synchronizing",
17       "details": "",
18       "unpropagatedInstanceIds": [
19         "497f6eca-6276-4993-bfeb-53cbbbba6f08"
20       ],
21       "relatedInstanceIds": [
22         "497f6eca-6276-4993-bfeb-53cbbbba6f08"
23       ],
24       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
25     },
26     "networkSecurityGroupInherited": false,
27     "controllerInstanceId": "158fc2bc-f2fb-4e1f-a5a4-2211062d14df",
28     "ipxeScript": null,
29     "alwaysBootWithCustomIpxe": false,
30     "userData": null,
31     "labels": {
32       "region": "portland",
33       "env": "staging"
34     },
35     "isUpdatePending": false,
36     "serialConsoleUrl": "ssh://user@nico.acme.com",
37     "interfaces": [
38       {
39         "id": "64d2028c-ae87-4069-a624-66089d957ef9",
40         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
41         "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
42         "isPhysical": true,
43         "device": null,
44         "deviceInstance": null,
45         "virtualFunctionId": null,
46         "macAddress": "2F-FC-34-AE-9C-2A",
47         "ipAddresses": [
48           "200.32.11.190"
49         ],
50         "status": "Ready",
51         "created": "2019-08-24T14:15:22Z",
52         "updated": "2019-08-24T14:15:22Z"
53       }
54     ],
55     "infinibandInterfaces": [
56       {
57         "id": "c518a0e8-3f49-4a1a-8935-a6d3dee6911e",
58         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
59         "partitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
60         "device": "MT2910 Family [ConnectX-7]",
61         "deviceInstance": 0,
62         "isPhysical": true,
63         "virtualFunctionId": null,
64         "guid": "946dae0300339498",
65         "status": "Ready",
66         "created": "2019-08-24T14:15:22Z",
67         "updated": "2019-08-24T14:15:22Z"
68       }
69     ],
70     "nvLinkInterfaces": [
71       {
72         "id": "fc19ab3f-1e52-4846-91bd-98743ff2752c",
73         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
74         "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
75         "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
76         "deviceInstance": 0,
77         "status": "Ready",
78         "created": "2019-08-24T14:15:22Z",
79         "updated": "2019-08-24T14:15:22Z"
80       },
81       {
82         "id": "c0ae6ec4-9a77-4358-baad-ee8cc3332c91",
83         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
84         "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
85         "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
86         "deviceInstance": 1,
87         "status": "Ready",
88         "created": "2019-08-24T14:15:22Z",
89         "updated": "2019-08-24T14:15:22Z"
90       },
91       {
92         "id": "aa44ff62-d86b-4db6-9fa4-90a19b05be01",
93         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
94         "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
95         "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
96         "deviceInstance": 2,
97         "status": "Ready",
98         "created": "2019-08-24T14:15:22Z",
99         "updated": "2019-08-24T14:15:22Z"
100       },
101       {
102         "id": "a403d1ca-2c07-410a-9678-3eb44d570ad9",
103         "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
104         "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
105         "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
106         "deviceInstance": 3,
107         "status": "Ready",
108         "created": "2019-08-24T14:15:22Z",
109         "updated": "2019-08-24T14:15:22Z"
110       }
111     ],
112     "dpuExtensionServiceDeployments": [],
113     "sshKeyGroupIds": [
114       "497f6eca-6276-4993-bfeb-53cbbbba6f08"
115     ],
116     "sshKeyGroups": [
117       {
118         "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
119         "name": "reno-integration-sre",
120         "description": "SRE access SSH keys for Reno Integration",
121         "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
122         "status": "Syncing",
123         "created": "2019-08-24T14:15:22Z",
124         "updated": "2019-08-24T14:15:22Z"
125       }
126     ],
127     "tpmEkCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUMxVENDQWJ5Z0F3SUJBZ0lVTEE1ZHFPK1E5OXZQM3VYRTRKcjBncVRtOW93d0RRWUpLb1pJaHZjTkFRRUwKQlFBd0xqRUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQW9NQ2s1MmFXUnBZU0JEYjNKNw==",
128     "status": "Ready",
129     "statusHistory": [
130       {
131         "status": "BootCompleted",
132         "message": "The Instance successfully completed boot",
133         "created": "2019-08-24T14:15:22Z",
134         "updated": "2019-08-24T14:15:22Z"
135       }
136     ],
137     "deprecations": [
138       {
139         "attribute": "sshkeygroups",
140         "replacedBy": "sshKeyGroups",
141         "takeActionBy": "2025-09-04T00:00:00Z",
142         "notice": "'sshkeygroups' is being deprecated in favor of 'sshKeyGroups'. Please take action prior to the specified date."
143       }
144     ],
145     "created": "2019-08-24T14:15:22Z",
146     "updated": "2019-08-24T14:15:22Z"
147   }
148 ]

Get all Instances for Tenant.

Org must have a Tenant entity. 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

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"

Filter by Infrastructure Provider ID

siteIdstringOptionalformat: "uuid"

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

vpcIdstringOptionalformat: "uuid"

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

instanceTypeIdstringOptionalformat: "uuid"

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

operatingSystemIdstringOptionalformat: "uuid"

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

machineIdstringOptional

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

namestringOptional

Filter by Instance name

statusstringOptional

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

ipAddressstringOptional

Filter by IP address. Can be specified multiple times to filter on more than one IP address.

querystringOptional

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

includeRelationenumOptional

Related entity to expand

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

networkSecurityGroupIdstringOptional

Filter by Network Security Group ID. Can be specified multiple times to filter on more than one Network Security Group.

Response headers

Response

idstringRead-onlyformat: "uuid"

Unique identifier for the Instance

namestring2-256 characters

Name for the Instance

descriptionstring or null

Description for the Instance

tenantIdstringformat: "uuid"

ID of the Tenant the Instance belongs to

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that owns the Site where the Instance is located

siteIdstringformat: "uuid"

ID of the Site where the Instance is located

instanceTypeIdstring or nullformat: "uuid"

ID of the Instance Type

vpcIdstringformat: "uuid"

ID of the VPC

secondaryVpcIdslist of strings

IDs of VPCs attached to the Instance through non-primary interfaces

machineIdstring or null

ID of the Machine

operatingSystemIdstring or nullformat: "uuid"

ID of the Operating System

networkSecurityGroupIdstring or null

ID of the attached Network Security Group, if any

networkSecurityGroupPropagationDetailsobject

Propagation details for the attached Network Security Group

networkSecurityGroupInheritedboolean

Indicates if the Network Security Group is inherited from VPC

controllerInstanceIdstring or nullformat: "uuid"

ID of the Instance in Site Controller

ipxeScriptstring or null

Attribute which is inherited from Operating System

alwaysBootWithCustomIpxeboolean

Indicates whether the Instance should always execute custom iPXE script when rebooting

phoneHomeEnabledboolean

Indicates whether the Phone Home service should be enabled or disabled for the Instance

userDatastring or null

UserData is inherited from Operating System or specified by user if allowed

labelsmap from strings to strings

User-specified Instance labels

isUpdatePendingboolean

Indicates whether an update is available for the Instance. Updates can be applied on reboot

serialConsoleUrlstring or null

Serial Console URL for the Instance. Format: ssh://<id>@siteSerialConsoleHostname

autoNetworkboolean

True when this Instance uses NICo auto-resolved networking from the host’s underlay (HostInband) network segments. When true, the caller’s request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.

interfaceslist of objects

Interfaces are list of the subnet associated with the Instance

infinibandInterfaceslist of objects

InfiniBandInterfaces are list of the InfiniBandInterface associated with the Instance

nvLinkInterfaceslist of objects

NVLinkInterfaces are list of the NVLinkInterface associated with the Instance

dpuExtensionServiceDeploymentslist of objects

DPU Extension Services deployed on DPUs of this Instance

sshKeyGroupIdslist of strings

IDs of SSH Key Groups associated with this Instance

sshKeyGroupslist of objects

IDs of SSH Key Groups associated with this Instance

tpmEkCertificatestring or null

base64 encoded TPM EK Certificate associated with this Instance

statusenum

Status of the Instance

statusHistorylist of objects

Chronological status history for the Instance

deprecationslist of objects

Deprecation notices for fields returned by this resource

createddatetimeRead-only

Date/time when the Instance was created

updateddatetimeRead-only

Date/time when the Instance was last updated

Errors

403

Forbidden Error