Sign in
Instance

Retrieve all Instances

Get all Instances for Tenant.

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

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

Query parameters

infrastructureProviderIdstring uuid

Filter by Infrastructure Provider ID

siteIdstring uuid

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

vpcIdstring uuid

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

instanceTypeIdstring uuid

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

operatingSystemIdstring uuid

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

machineIdstring

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

namestring

Filter by Instance name

statusstring

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

ipAddressstring

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

querystring

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

includeRelation'InfrastructureProvider' | 'Tenant' | 'Site' | 'InstanceType' | 'Allocation' | 'VPC' | 'Machine' | 'OperatingSystem' | 'NetworkSecurityGroup'

Related entity to expand

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC' | 'MACHINE_ID_ASC' | 'MACHINE_ID_DESC' | 'TENANT_ORG_DISPLAY_NAME_ASC' | 'TENANT_ORG_DISPLAY_NAME_DESC' | 'INSTANCE_TYPE_NAME_ASC' | 'INSTANCE_TYPE_NAME_DESC' | 'HAS_INFINIBAND_ASC' | 'HAS_INFINIBAND_DESC'

Ordering for pagination query

networkSecurityGroupIdstring

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

Response

OK

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
vpcIdstring uuid
secondaryVpcIdsstring[]

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

machineIdstring nullable
operatingSystemIdstring uuid nullable
networkSecurityGroupIdstring nullable
networkSecurityGroupInheritedboolean

Indicates if the Network Security Group is inherited from VPC

controllerInstanceIdstring uuid nullable
ipxeScriptstring nullable
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 Instance

userDatastring nullable
labelsLabels
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'Pending' | 'Provisioning' | 'Configuring' | 'Ready' | 'Updating' | 'Repairing' | 'Rebooting' | 'Terminating' | 'Error'

Status values for Instance objects

createdstring date-time
updatedstring date-time

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": {
      "id": "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"
      }
    ],
    "deprecations": [
      {
        "attribute": "sshkeygroups",
        "replacedBy": "sshKeyGroups",
        "takeActionBy": "2025-09-04T00:00:00Z",
        "notice": "'sshkeygroups' is being deprecated in favor of 'sshKeyGroups'. Please take action prior to the specified date."
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes