Update Instance
Update an Instance by ID
Org must have a Tenant entity. Instance must belong to Tenant. User must have authorization role with TENANT_ADMIN suffix.
A non-empty powerProfile requires the Site’s dpsPowerManagement capability to be true; otherwise the request returns 412. Omission or null preserves the current profile, while an empty string clears it even when DPS power management is disabled.
Authentication
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
Request
ID of the Network Security Group to attach to the Instance. This Instance-level policy takes precedence over VPC-level policy on every Interface, including cross-Tenant VPC Interfaces.
Power profile to apply to the Instance. A non-empty value requires the Site’s dpsPowerManagement capability to be true. Omission or null preserves the current profile; an empty string clears it when DPS power management is disabled.
Any user-data to be sent to the booting OS. For example, cloud-init data. Limited to 32768 bytes (32 KiB), measured on the effective value NICo stores rather than the text submitted. Operating System defaults are inherited first, and when phone-home is configured the document is re-serialized with a phone_home block added. Re-serialization normalizes indentation and can grow the document, so a request just under the limit may still be rejected.
Complete IDs of additional VPCs the Instance should attach to through non-primary Interfaces. With effective crossTenantInterfaceCreation, these may include same-Site FNN VPC IDs owned by another Tenant, obtained out of band; the capability does not expose them through VPC discovery. This field may only be specified when every entry in interfaces uses vpcPrefixId or vpcId. IDs must be unique, valid UUIDs, and must not include the primary vpcId.
Complete updated Interface configuration for the Instance. Interfaces must all be Subnet-backed or all be VPC-backed; VPC-backed interfaces may use an explicit vpcPrefixId or ask the Controller to select a prefix using vpcId and ipFamilies. Adding or retargeting a cross-Tenant Interface requires effective crossTenantInterfaceCreation; unchanged and removed cross-Tenant Interfaces do not. Cross-Tenant Subnets remain unsupported, and the primary physical Interface must still select the Instance Tenant-owned primary VPC. Mutually exclusive with autoNetwork: when autoNetwork is true this list MUST be empty.
When set, asks NICo to auto-resolve the Instance’s network interfaces from the host’s underlay (HostInband) segments. null leaves the value unchanged; true (re-)resolves; false returns to explicit interface configuration. When true, the Instance’s VPC MUST already have networkVirtualizationType: FLAT, interfaces MUST be empty or omitted, and secondaryVpcIds MUST be empty or omitted.
Update SpectrumX Partition attachments of the Instance. Omission or null leaves attachments unchanged; an explicit list replaces them entirely. An empty list removes attachments without capability validation. A nonempty list, including an unchanged list, is validated against the Instance’s individual Machine capabilities persisted by inventory reconciliation before any update is persisted. Instance Type capability summaries are not used. Missing capabilities or invalid selectors return 400. Final Site validation remains authoritative because persisted inventory can lag behind the Site. Each device and deviceInstance pair may appear only once, irrespective of virtualFunctionId. Removing attachments from a running Instance immediately stops SpectrumX traffic on the detached NICs, but the guest may retain their IPv4 addresses and routes until the DHCP lease issued by the DOCA Weave DHCP agent expires (1 hour by default). NICo does not set this lease duration. Addresses and routes may remain longer if the guest DHCP client does not honor lease expiry. Replacing attachments on a running Instance, such as moving a NIC to a Partition with a different VNI, may leave the guest using its old address until DHCP renewal. Renew DHCP or restart networking on the affected NICs after replacing attachments.
Update NVLink Interfaces of the Instance. A subset of GPUs may be specified. Each item references a GPU index (deviceInstance) and an NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions. Partial updates are not allowed; specified interfaces will delete or replace existing Interfaces. Updating is not allowed if the Instance’s VPC has the nvLinkLogicalPartitionId attribute set.
Response
IDs of VPCs attached to the Instance through non-primary interfaces
User-specified Instance labels
Serial Console URL for the Instance. Format: ssh://<id>@siteSerialConsoleHostname
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.
Date/time when the Instance was created
Date/time when the Instance was last updated