Credential Rotation

Get Credential Rotation Status

Changed on

Report convergence of an in-flight or completed site-wide credential rotation. When deviceMac is set, the counts describe just that device and a per-device detail block is returned. Equivalent to nico-admin-cli credential rotation-status.

User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/credential/rotation

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/credential/rotation
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site to query.

credentialType'BMC' | 'HostUEFI' | 'DPUUEFI' | 'NVOS' | 'LockdownIKM' required

Credential family to report.

deviceMacstring

Report only this device's convergence, matched by MAC.

Response

Credential rotation status

targetVersioninteger required

Current site-wide target version for this family.

convergedinteger required

Number of devices at or beyond the target version.

pendinginteger required

Number of devices not yet converged and eligible to rotate.

quarantinedinteger required

Number of devices currently in a rotation backoff window.

quarantinedDeviceMacsstring[] nullable

MAC addresses of the quarantined devices.

startedstring date-time nullable

When the current target version was staged.

completeboolean required

True only when every device in the queried set has reached the target with none pending and none quarantined.

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status