Get Credential Rotation Status

GET

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

GET

/v2/org/:org/nico/credential/rotation

$ curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d credentialType=BMC \
>      -d siteId=siteId

1 {
2   "targetVersion": 5,
3   "converged": 120,
4   "pending": 15,
5   "quarantined": 3,
6   "complete": false,
7   "quarantinedDeviceMacs": [
8     "00:1A:2B:3C:4D:5E",
9     "00:1A:2B:3C:4D:5F",
10     "00:1A:2B:3C:4D:60"
11   ],
12   "started": "2024-04-10T08:45:00Z",
13   "device": {
14     "deviceMac": "00:1A:2B:3C:4D:5E",
15     "converged": false,
16     "quarantined": true,
17     "rotateAttempts": 2,
18     "currentVersion": 4,
19     "rotatingToVersion": 5,
20     "quarantinedUntil": "2024-04-10T09:15:00Z",
21     "lastAttempted": "2024-04-10T08:50:00Z",
22     "lastError": "Timeout during credential update"
23   }
24 }

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.

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

``` 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

siteIdstringRequiredformat: "uuid"

ID of the Site to query.

credentialTypeenumRequired

Credential family to report.

Allowed values:

deviceMacstringOptional

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

Response

Credential rotation status

targetVersionlong

Current site-wide target version for this family.

convergedlong

Number of devices at or beyond the target version.

pendinglong

Number of devices not yet converged and eligible to rotate.

quarantinedlong

Number of devices currently in a rotation backoff window.

completeboolean

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

quarantinedDeviceMacslist of strings or null

MAC addresses of the quarantined devices.

starteddatetime or null

When the current target version was staged.

deviceobject

Per-device convergence detail, returned only for a MAC-targeted status query.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error