Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Tray

Power control Trays

Power control Trays with optional filters. If no filter is specified, targets all trays in the Site.

Supported power states: on, off, cycle, forceoff, forcecycle.

Filter constraints:

  • rackId and rackName are mutually exclusive
  • rackId/rackName cannot be combined with ids/componentIds (rack-level vs component-level targeting)
  • componentIds requires type to be specified

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

patch/v2/org/{org}/nico/tray/power

Request body

siteIdstring uuid required

ID of the Site

state'on' | 'off' | 'cycle' | 'forceoff' | 'forcecycle' required

Target power state

ruleIdstring uuid

Optional Operation Rule UUID. When set, pins every task spawned by this batch to the named rule and overrides Flow's default rule resolution.

overrideReadinessCheckboolean

When true, proceed even if one or more target components (or hosts on the owning rack for rack-scoped components) are reported as not ready by their persisted status. Intended for operator-supervised maintenance.

Response

OK

taskIdsstring[]

List of task IDs created for the power control operation (one per rack)

Example response

{
  "taskIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}