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

# Regenerate API key

POST https://app.kuudo.com/api/developers/api-keys/{id}/regenerate

Rotates an API key: the old key is revoked immediately and a new key with the same name, description, M2M client, and original expiry is returned with HTTP 200. The new apiToken is shown only once. A bearer caller may rotate only its own authenticated M2M client's key (403 PERMISSION_DENIED for another client, before revoking the old key). The bearer must also hold every scope of the key's M2M client (403 PERMISSION_DENIED with details.exceedingScopes otherwise). An inactive M2M client returns 400. The organization's API key plan limit applies (403).

Requires every scope: `api-keys:write`.

Reference: https://docs.kuudo.com/api-reference/developer-credentials/regenerate-api-key

## Authentication

- `Authorization` header (bearer token, required) — JWT returned by POST /api/auth/token-exchange. Amazon, authorization invitations, and developer credentials require API-key-derived tokens.

## Request

### Path parameters

- `id` (integer, required) — Numeric API key ID.

## Response

### 200

Success. apiToken is returned only in this response.

- `apiKey` (ApiKeyCreated, required)
- `oldKeyId` (integer, required) — ID of the revoked key.

## Errors

### 400 Bad Request Error

Invalid request or unsupported resource state.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 401 Unauthorized Error

Missing or invalid credentials, or inactive machine principal.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 403 Forbidden Error

Insufficient scope, authorization policy, or entitlement.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 404 Not Found Error

Resource not found or not visible to this principal.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 500 Internal Server Error

Internal error.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 503 Service Unavailable Error

Dependency unavailable or application maintenance.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

## Types

### ApiKeyCreated

- `id` (integer, required)
- `name` (string, required)
- `description` (string, required, nullable)
- `apiKeyPrefix` (string, required)
- `apiToken` (string, required) — Long-lived sk_live_* or sk_test_* key, shown only once. Treat as a secret; exchange it at POST /api/auth/token-exchange.
- `m2mClient` (ApiKeyM2MClient, required)
- `expiresAt` (datetime, required, nullable)
- `createdAt` (datetime, required)
- `warning` (string, required)

### ErrorError

- string
- ErrorError1

### ApiKeyM2MClient

- `clientId` (string, required)
- `name` (string, required)
- `scopes` (list of string, required)
- `environment` (enum, required)
  - Allowed values: `production`, `development`
- `status` (string, required)

### ErrorError1

- `code` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
{
  "apiKey": {
    "id": 1,
    "name": "string",
    "description": "string",
    "apiKeyPrefix": "string",
    "apiToken": "string",
    "m2mClient": {
      "clientId": "string",
      "name": "string",
      "scopes": [
        "string"
      ],
      "environment": "production",
      "status": "string"
    },
    "expiresAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "warning": "string"
  },
  "oldKeyId": 1
}
```

**SDK Code**

```python
import requests

url = "https://app.kuudo.com/api/developers/api-keys/1/regenerate"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://app.kuudo.com/api/developers/api-keys/1/regenerate';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kuudo.com/api/developers/api-keys/1/regenerate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://app.kuudo.com/api/developers/api-keys/1/regenerate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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://app.kuudo.com/api/developers/api-keys/1/regenerate")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.kuudo.com/api/developers/api-keys/1/regenerate', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.kuudo.com/api/developers/api-keys/1/regenerate");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.kuudo.com/api/developers/api-keys/1/regenerate")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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