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

# Rotate Credential

POST https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/credential/rotation
Content-Type: application/json

Stage a site-wide credential rotation: publish a new rotate-to secret
and bump the site-wide target version. Devices converge to the new
version asynchronously; poll the status endpoint to observe
convergence. Equivalent to `nico-admin-cli credential rotate`.

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/rotate-credential

## 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:
    post:
      operationId: rotate-credential
      summary: Rotate Credential
      description: |-
        Stage a site-wide credential rotation: publish a new rotate-to secret
        and bump the site-wide target version. Devices converge to the new
        version asynchronously; poll the status endpoint to observe
        convergence. Equivalent to `nico-admin-cli credential rotate`.

        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: 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 was staged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialRotationResult'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialRotationRequest'
servers:
  - url: https://nico-rest-api.nico.svc.cluster.local
    description: Kubernetes Cluster
components:
  schemas:
    CredentialRotationRequestCredentialType:
      type: string
      enum:
        - BMC
        - HostUEFI
        - DPUUEFI
        - NVOS
        - LockdownIKM
      description: Credential family to rotate.
      title: CredentialRotationRequestCredentialType
    CredentialRotationRequest:
      type: object
      properties:
        siteId:
          type: string
          format: uuid
          description: ID of the Site whose credential family is rotated.
        credentialType:
          $ref: '#/components/schemas/CredentialRotationRequestCredentialType'
          description: Credential family to rotate.
        password:
          type: string
          description: >-
            Explicit rotate-to password. When omitted, a strong password is
            auto-generated. Never returned.
        reason:
          type: string
          description: >-
            Free-form operator note recorded with the rotation. Must not contain
            secrets.
      required:
        - siteId
        - credentialType
      description: Request to stage a site-wide credential rotation.
      title: CredentialRotationRequest
    CredentialRotationResultCredentialType:
      type: string
      enum:
        - BMC
        - HostUEFI
        - DPUUEFI
        - NVOS
        - LockdownIKM
      description: Credential family that was rotated.
      title: CredentialRotationResultCredentialType
    CredentialRotationResult:
      type: object
      properties:
        credentialType:
          $ref: '#/components/schemas/CredentialRotationResultCredentialType'
          description: Credential family that was rotated.
        targetVersion:
          type: integer
          format: int64
          description: Newly published site-wide target version that devices converge to.
        started:
          type:
            - string
            - 'null'
          format: date-time
          description: When the rotation was staged.
      required:
        - credentialType
        - targetVersion
      description: >-
        Result returned when a credential rotation is staged. The password is
        never returned.
      title: CredentialRotationResult
    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
{
  "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "credentialType": "BMC"
}
```

**Response**

```json
{
  "credentialType": "BMC",
  "targetVersion": 42,
  "started": "2024-04-20T14:45:00Z"
}
```

**SDK Code**

```python
import requests

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

payload = {
    "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "credentialType": "BMC"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"siteId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","credentialType":"BMC"}'
};

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"

	payload := strings.NewReader("{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"credentialType\": \"BMC\"\n}")

	req, _ := http.NewRequest("POST", 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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"credentialType\": \"BMC\"\n}"

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.post("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"credentialType\": \"BMC\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/credential/rotation', [
  'body' => '{
  "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "credentialType": "BMC"
}',
  '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");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"credentialType\": \"BMC\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "credentialType": "BMC"
] 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")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```