> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/infra-controller/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/infra-controller/_mcp/server.

# Get Credential Rotation Status

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

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.

Reference: https://docs.nvidia.com/infra-controller/infra-controller/rest-api-reference/api-reference/credential-rotation/get-credential-rotation-status

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: NVIDIA Infra Controller REST API
  version: 1.0.0
paths:
  /v2/org/{org}/nico/credential/rotation:
    get:
      operationId: get-credential-rotation-status
      summary: Get Credential Rotation Status
      description: |-
        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.
      tags:
        - credentialRotation
      parameters:
        - name: org
          in: path
          description: Name of the Org
          required: true
          schema:
            type: string
        - name: siteId
          in: query
          description: ID of the Site to query.
          required: true
          schema:
            type: string
            format: uuid
        - name: credentialType
          in: query
          description: Credential family to report.
          required: true
          schema:
            $ref: >-
              #/components/schemas/V2OrgOrgNicoCredentialRotationGetParametersCredentialType
        - name: deviceMac
          in: query
          description: Report only this device's convergence, matched by MAC.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ```

            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

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Credential rotation status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialRotationStatus'
        '400':
          description: Error response when request data cannot be validated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NICoAPIError'
        '403':
          description: >-
            Error response when user is not authorized to call an endpoint or
            retrieve/modify objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NICoAPIError'
        '404':
          description: No rotation record exists for the requested device
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NICoAPIError'
servers:
  - url: https://nico-rest-api.nico.svc.cluster.local
    description: Kubernetes Cluster
components:
  schemas:
    V2OrgOrgNicoCredentialRotationGetParametersCredentialType:
      type: string
      enum:
        - BMC
        - HostUEFI
        - DPUUEFI
        - NVOS
        - LockdownIKM
      title: V2OrgOrgNicoCredentialRotationGetParametersCredentialType
    DeviceCredentialRotationStatus:
      type: object
      properties:
        deviceMac:
          type: string
          description: The device this status describes.
        currentVersion:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Credential version live on the hardware. Null when not yet
            established.
        rotatingToVersion:
          type:
            - integer
            - 'null'
          format: int64
          description: Set while a rotation is mid-flight on this device.
        converged:
          type: boolean
          description: True once the current version reaches the site-wide target.
        quarantined:
          type: boolean
          description: True while the device is in a rotation backoff window.
        quarantinedUntil:
          type:
            - string
            - 'null'
          format: date-time
          description: When the current backoff window expires; set only while quarantined.
        rotateAttempts:
          type: integer
          format: int64
          description: Number of rotation attempts recorded for this device.
        lastAttempted:
          type:
            - string
            - 'null'
          format: date-time
          description: When the last rotation attempt ran; null if none.
        lastError:
          type:
            - string
            - 'null'
          description: Redacted last-error string for observability; never a secret.
      required:
        - deviceMac
        - converged
        - quarantined
        - rotateAttempts
      description: >-
        Per-device convergence detail, returned only for a MAC-targeted status
        query.
      title: DeviceCredentialRotationStatus
    CredentialRotationStatus:
      type: object
      properties:
        targetVersion:
          type: integer
          format: int64
          description: Current site-wide target version for this family.
        converged:
          type: integer
          format: int64
          description: Number of devices at or beyond the target version.
        pending:
          type: integer
          format: int64
          description: Number of devices not yet converged and eligible to rotate.
        quarantined:
          type: integer
          format: int64
          description: Number of devices currently in a rotation backoff window.
        quarantinedDeviceMacs:
          type:
            - array
            - 'null'
          items:
            type: string
          description: MAC addresses of the quarantined devices.
        started:
          type:
            - string
            - 'null'
          format: date-time
          description: When the current target version was staged.
        complete:
          type: boolean
          description: >-
            True only when every device in the queried set has reached the
            target with none pending and none quarantined.
        device:
          $ref: '#/components/schemas/DeviceCredentialRotationStatus'
      required:
        - targetVersion
        - converged
        - pending
        - quarantined
        - complete
      description: >-
        Convergence status of an in-flight or completed site-wide credential
        rotation.
      title: CredentialRotationStatus
    NiCoApiErrorSource:
      type: string
      enum:
        - nico
      description: Source of the error.
      title: NiCoApiErrorSource
    NiCoApiErrorData:
      type: object
      properties: {}
      description: Additional data about the error
      title: NiCoApiErrorData
    NICoAPIError:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/NiCoApiErrorSource'
          description: Source of the error.
        message:
          type: string
          description: Message describing the error
        data:
          oneOf:
            - $ref: '#/components/schemas/NiCoApiErrorData'
            - type: 'null'
          description: Additional data about the error
      description: Describes the error response from NVIDIA Infra Controller REST API
      title: NICoAPIError
  securitySchemes:
    JWTBearerToken:
      type: http
      scheme: bearer
      description: >-
        ```

        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

        ```

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "targetVersion": 5,
  "converged": 120,
  "pending": 15,
  "quarantined": 3,
  "complete": false,
  "quarantinedDeviceMacs": [
    "00:1A:2B:3C:4D:5E",
    "00:1A:2B:3C:4D:5F",
    "00:1A:2B:3C:4D:60"
  ],
  "started": "2024-04-10T08:45:00Z",
  "device": {
    "deviceMac": "00:1A:2B:3C:4D:5E",
    "converged": false,
    "quarantined": true,
    "rotateAttempts": 2,
    "currentVersion": 4,
    "rotatingToVersion": 5,
    "quarantinedUntil": "2024-04-10T09:15:00Z",
    "lastAttempted": "2024-04-10T08:50:00Z",
    "lastError": "Timeout during credential update"
  }
}
```

**SDK Code**

```python
import requests

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

querystring = {"credentialType":"BMC","siteId":"siteId"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation?credentialType=BMC&siteId=siteId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```