Skip to navigation
API ReferenceExpected Rack Group

Replace all Expected Rack Groups

Deprecated
View as Markdown

Deprecated compatibility route. Use PUT /v2/org/{org}/nico/expected-rack-group/all instead. This route preserves the same Site scoping, authorization, validation, response, and mutation semantics during migration.

Replace the full set of Expected Rack Groups for a Site with the provided list. All existing rows for the Site are deleted and the supplied replacement set is created atomically, so response UUIDs may differ from earlier rows even when rackGroupId is unchanged.

Every entry in expectedRackGroups must reference the same siteId as the top-level siteId. The rackGroupId values must be unique within the request. The expectedRackGroups array may be empty to clear all Expected Rack Groups for the Site.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also replace Expected Rack Groups if they have an account with the Site’s Infrastructure Provider.

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

Request

Replace-all Expected Rack Groups request

siteIdstringRequiredformat: "uuid"
ID of the Site whose Expected Rack Groups should be replaced
expectedRackGroupslist of objectsRequired

The full desired set of Expected Rack Groups for the Site. Every entry must reference the same siteId as the top-level field, and rackGroupId values must be unique within the request. Required and non-null. Use an explicit empty array to clear all Expected Rack Groups for the Site.

Response

OK
idstringOptionalRead-onlyformat: "uuid"

Unique identifier (UUID) for the Expected Rack Group

rackGroupIdstringOptionalRead-only

Operator-supplied identifier for the rack group (opaque string; UUID syntax is not required). Unique within a Site.

siteIdstringOptionalRead-onlyformat: "uuid"
ID of the Site the Expected Rack Group belongs to
siteobject or nullOptional

Site details when requested through includeRelation; otherwise null.

topologystringOptional

External group-level NVLink topology identifier.

protocolstring or nullOptional
Rack fabric protocol. Null only for declarations created before protocol became required.
rackslist of objectsOptional

Ordered racks and their devices. Arrays are always present, including empty lists. Rack IDs and device identity tuples are unique across the group, with case-sensitive comparison.

namestringOptional

Human-readable name of the Expected Rack Group

descriptionstringOptional

Human-readable description of the Expected Rack Group

labelsmap from strings to stringsOptional

User-defined key-value pairs for organizing and categorizing Expected Rack Groups. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

createddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Rack Group was created
updateddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Rack Group was last updated

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error