Retrieve all Instances

GET

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

GET

/v2/org/:org/nico/instance

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance \
     -H "Authorization: Bearer <token>" \
     -d pageSize=20

[
  {
    "networkSecurityGroupPropagationDetails": {
      "objectId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "detailedStatus": "Partial",
      "status": "Synchronizing",
      "details": "",
      "unpropagatedInstanceIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "relatedInstanceIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    },
    "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",
    "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e,",
    "networkSecurityGroupInherited": false,
    "controllerInstanceId": "158fc2bc-f2fb-4e1f-a5a4-2211062d14df",
    "ipxeScript": null,
    "alwaysBootWithCustomIpxe": false,
    "userData": null,
    "labels": {
      "env": "staging",
      "region": "portland"
    },
    "isUpdatePending": false,
    "serialConsoleUrl": "ssh://user@nico.acme.com",
    "interfaces": [
      {
        "instanceTenantId": null,
        "vpcTenantId": null,
        "id": "64d2028c-ae87-4069-a624-66089d957ef9",
        "instanceId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
        "isPhysical": true,
        "device": null,
        "deviceInstance": null,
        "virtualFunctionId": null,
        "macAddress": "2F-FC-34-AE-9C-2A",
        "ipAddresses": [
          "200.32.11.190"
        ],
        "status": "Ready",
        "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": "c0ae6ec4-9a77-4358-baad-ee8cc3332c91",
        "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": "aa44ff62-d86b-4db6-9fa4-90a19b05be01",
        "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": "a403d1ca-2c07-410a-9678-3eb44d570ad9",
        "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",
        "status": "Syncing",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z",
        "description": "SRE access SSH keys for Reno Integration",
        "version": "fbc692b61ffef6fbfc38a3833f6b7e7ae508da75"
      }
    ],
    "tpmEkCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUMxVENDQWJ5Z0F3SUJBZ0lVTEE1ZHFPK1E5OXZQM3VYRTRKcjBncVRtOW93d0RRWUpLb1pJaHZjTkFRRUwKQlFBd0xqRUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQW9NQ2s1MmFXUnBZU0JEYjNKNw==",
    "status": "Ready",
    "statusHistory": [
      {
        "status": "BootCompleted",
        "message": "The Instance successfully completed boot",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

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

Path parameters

orgstringRequired

Name of the Org

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

Filter by Infrastructure Provider ID. Deprecated: Instances will no longer be filtered by Infrastructure Provider; results are scoped to the org’s Tenant. Use the siteId parameter to scope results to a specific Infrastructure Provider’s Sites.

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

pageNumberintegerOptional1-21474836

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

networkSecurityGroupPropagationDetailsobject or null

Network Security Group propagation details. Null when no details are available, including when no Network Security Group is attached or inherited.

idstringOptionalRead-onlyformat: "uuid"

Unique identifier for the Instance

namestringOptional2-256 characters

Name for the Instance

descriptionstring or nullOptional

Description for the Instance

tenantIdstringOptionalformat: "uuid"

ID of the Tenant the Instance belongs to

infrastructureProviderIdstringOptionalformat: "uuid"

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

siteIdstringOptionalformat: "uuid"

ID of the Site where the Instance is located

instanceTypeIdstring or nullOptionalformat: "uuid"

ID of the Instance Type

vpcIdstringOptionalformat: "uuid"

ID of the VPC

secondaryVpcIdslist of stringsOptional

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

machineIdstring or nullOptional

ID of the Machine

operatingSystemIdstring or nullOptionalformat: "uuid"

ID of the Operating System

networkSecurityGroupIdstring or nullOptional

ID of the attached Network Security Group, if any

powerProfilestring or nullOptional

External power provisioning profile associated with the Instance.

networkSecurityGroupInheritedbooleanOptional

Indicates if the Network Security Group is inherited from VPC

controllerInstanceIdstring or nullOptionalformat: "uuid"

ID of the Instance in Site Controller

ipxeScriptstring or nullOptional

Attribute which is inherited from Operating System

alwaysBootWithCustomIpxebooleanOptional

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

phoneHomeEnabledbooleanOptional

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

userDatastring or nullOptional

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

labelsmap from strings to stringsOptional

User-specified Instance labels

isUpdatePendingbooleanOptional

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

serialConsoleUrlstring or nullOptional

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

autoNetworkbooleanOptional

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 objectsOptional

Interfaces are list of the subnet associated with the Instance

infinibandInterfaceslist of objectsOptional

InfiniBandInterfaces are list of the InfiniBandInterface associated with the Instance

spectrumXAttachmentslist of objectsOptional

SpectrumXAttachments are list of the SpectrumXAttachment associated with the Instance

nvLinkInterfaceslist of objectsOptional

NVLinkInterfaces are list of the NVLinkInterface associated with the Instance

dpuExtensionServiceDeploymentslist of objectsOptional

DPU Extension Services deployed on DPUs of this Instance

sshKeyGroupIdslist of stringsOptional

IDs of SSH Key Groups associated with this Instance

sshKeyGroupslist of objectsOptional

SSH Key Groups associated with this Instance, in summary form

tpmEkCertificatestring or nullOptional

base64 encoded TPM EK Certificate associated with this Instance

statusenumOptional

Status of the Instance

statusHistorylist of objectsOptional

Chronological status history for the Instance

deprecationslist of objectsOptional

Deprecations active for this resource. Returned only if there are active deprecations.

createddatetimeOptionalRead-only

Date/time when the Instance was created

updateddatetimeOptionalRead-only

Date/time when the Instance was last updated

Errors

403

Forbidden Error