Allocation6

Audit2

BMC Credential1

Credential Rotation2

Domain6

DPU Extension Service7

DPU Machine2

Expected Machine11

Expected Power Shelf7

Expected Rack8

Expected Rack Group8

Expected Switch7

Host Firmware Config2

InfiniBand Partition6

Infrastructure Provider2

Instance10

Instance Type8

IP Block6

iPXE Template2

Machine25

Measured Boot Trusted Machine3

Measured Boot Trusted Profile3

Metadata1

Network Security Group5

NVLink Logical Partition6

Operating System5

Rack14

Rule5

Service Account1

Site6

Site Explorer2

SKU5

SpectrumX Partition4

SSH Key5

SSH Key Group5

Subnet5

Task3

Task Run8

Tenant4

Tenant Account5

Tenant Identity10

Tray12

UEFI Credential1

User1

VPC9

VPC Peering4

VPC Prefix5

Instance

Retrieve Instance

Changed on Oct 22, 2026

Get an Instance by ID

Org must have a Tenant entity. Instance must belong to Tenant. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/instance/{instanceId}

Request

Base URL
https://nico-rest-api.nico.svc.cluster.local
URL
https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/instance/{instanceId}
Auth
HTTP bearer

Query parameters

Related entity to expand

Response

idstring uuid

Unique identifier for the Instance

namestring

Name for the Instance

descriptionstring nullable

Description for the Instance

tenantIdstring uuid

ID of the Tenant the Instance belongs to

infrastructureProviderIdstring uuid

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

siteIdstring uuid

ID of the Site where the Instance is located

instanceTypeIdstring uuid nullable

ID of the Instance Type

vpcIdstring uuid

ID of the VPC

secondaryVpcIdsstring[]

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

machineIdstring nullable

ID of the Machine

operatingSystemIdstring uuid nullable

ID of the Operating System

networkSecurityGroupIdstring nullable

ID of the attached Network Security Group, if any

powerProfilestring nullable

External power provisioning profile associated with the Instance.

networkSecurityGroupInheritedboolean

Indicates if the Network Security Group is inherited from VPC

controllerInstanceIdstring uuid nullable

ID of the Instance in Site Controller

ipxeScriptstring nullable

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 nullable

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

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

isUpdatePendingboolean

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

serialConsoleUrlstring nullable

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.

sshKeyGroupIdsstring[]

IDs of SSH Key Groups associated with this Instance

tpmEkCertificatestring nullable

base64 encoded TPM EK Certificate associated with this Instance

Status values for Instance objects

createdstring date-time

Date/time when the Instance was created

updatedstring date-time

Date/time when the Instance was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "spark-monitor-1",
  "description": "Node for monitoring Spark",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
  "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
  "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
  "operatingSystemId": "eaeb86ee-c435-444e-9e01-8346f67f194b",
  "controllerInstanceId": null,
  "ipxeScript": null,
  "alwaysBootWithCustomIpxe": false,
  "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e",
  "networkSecurityGroupPropagationDetails": {
    "objectId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "detailedStatus": "Partial",
    "status": "Synchronizing",
    "details": "",
    "unpropagatedInstanceIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "relatedInstanceIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  },
  "networkSecurityGroupInherited": false,
  "userData": null,
  "labels": {
    "region": "portland",
    "env": "staging"
  },
  "isUpdatePending": false,
  "serialConsoleUrl": "ssh://user@nico.acme.com",
  "interfaces": [
    {
      "id": "64d2028c-ae87-4069-a624-66089d957ef9",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
      "isPhysical": true,
      "virtualFunctionId": null,
      "macAddress": null,
      "ipAddresses": [],
      "status": "Pending",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "infinibandInterfaces": [
    {
      "id": "c518a0e8-3f49-4a1a-8935-a6d3dee6911e",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "partitionId": "05ef7e84-1d4e-4e4d-980d-38589479a0fe",
      "device": "MT2910 Family [ConnectX-7]",
      "deviceInstance": 0,
      "isPhysical": true,
      "virtualFunctionId": null,
      "guid": "946dae0300339498",
      "status": "Ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "nvLinkInterfaces": [
    {
      "id": "fc19ab3f-1e52-4846-91bd-98743ff2752c",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
      "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
      "deviceInstance": 0,
      "status": "Ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    {
      "id": "fc19ab3f-1e52-4846-91bd-98743ff2752c",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
      "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
      "deviceInstance": 1,
      "status": "Ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    {
      "id": "fc19ab3f-1e52-4846-91bd-98743ff2752c",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
      "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
      "deviceInstance": 2,
      "status": "Ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    },
    {
      "id": "fc19ab3f-1e52-4846-91bd-98743ff2752c",
      "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "nvLinkLogicalPartitionId": "2f8676fd-d228-4db5-ac76-1cfc74f48a23",
      "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
      "deviceInstance": 3,
      "status": "Ready",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "dpuExtensionServiceDeployments": [],
  "sshKeyGroupIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "sshKeyGroups": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "reno-integration-sre",
      "description": "SRE access SSH keys for Reno Integration",
      "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75",
      "status": "Syncing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "tpmEkCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUMxVENDQWJ5Z0F3SUJBZ0lVTEE1ZHFPK1E5OXZQM3VYRTRKcjBncVRtOW93d0RRWUpLb1pJaHZjTkFRRUwKQlFBd0xqRUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQW9NQ2s1MmFXUnBZU0JEYjNKNw==",
  "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"
}

Changes

Oct 22, 20263a9ac4059293 Revision changes
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  the response's property type changed from object to no type for status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  the response property became required for the status
Oct 20, 2026273aadbf1c41 Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new Unknown enum value to the response property for the response status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status

Operation history (20 revisions)