> This page is for Workforce.

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

# Regenerate access key secret

POST https://ah-api.merge.dev/api/v1/access-keys/{key_id}/regenerate/

Rotates the secret of an existing access key. Scope and expiration are preserved; only the secret value changes. The calling key may only regenerate itself or keys within its own scope; anything else returns 403. Keys linked to a service account have no secret to rotate and return 400.

Reference: https://docs.merge.dev/merge-workforce/agent-handler/access-keys/regenerate

## Authentication

- `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer"

## Request

### Path parameters

- `key_id` (string, required)

## Response

### 200

- `id` (string, required)
- `key` (string, required, nullable) — Raw secret value. Returned only on create or regenerate.
- `key_masked` (string, required) — Truncated form of the secret safe to display in UIs.
- `created_at` (datetime, required)
- `name` (string, optional) — Human-readable label for the key. Auto-generated if omitted.
- `tool_pack_ids` (list of string, optional, nullable) — Tool packs this key can access. Must be a subset of the parent key's `tool_pack_ids`. Pass `null` for unrestricted access to all tool packs in the organization.
- `registered_user_ids` (list of string, optional, nullable) — Registered users this key can access. Must be a subset of the parent key's `registered_user_ids`. Pass `null` for unrestricted access to all registered users in the organization.
- `scopes` (list of string, optional) — Limits which actions this key can perform. Available scopes: `runtime:all` (MCP tool calls), `management:all` (resource management endpoints).
- `is_test` (boolean, optional, default: false) — If true, the key can only authenticate test registered users.
- `expires_at` (datetime, optional, nullable) — Expiration timestamp. Must be before the parent key's `expires_at`. Defaults to 90 days from now if omitted. Pass `null` explicitly for a key that never expires.
- `expires_in` (integer, optional) — Seconds until the key expires. Alternative to `expires_at`.

## Errors

### 400 Bad Request Error

The key is linked to a service account and has no secret to rotate.

- `any`

### 403 Forbidden Error

The calling key does not cover the target key.

- `any`

## Examples

**Response**

```json
{
  "id": "string",
  "key": "string",
  "key_masked": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "name": "string",
  "tool_pack_ids": [
    "string"
  ],
  "registered_user_ids": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "is_test": false,
  "expires_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://ah-api.merge.dev/api/v1/access-keys/key_id/regenerate/"

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

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

print(response.json())
```

```javascript
const url = 'https://ah-api.merge.dev/api/v1/access-keys/key_id/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://ah-api.merge.dev/api/v1/access-keys/key_id/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://ah-api.merge.dev/api/v1/access-keys/key_id/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://ah-api.merge.dev/api/v1/access-keys/key_id/regenerate/")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ah-api.merge.dev/api/v1/access-keys/key_id/regenerate/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ah-api.merge.dev/api/v1/access-keys/key_id/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://ah-api.merge.dev/api/v1/access-keys/key_id/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()
```