# POST /api/api-keys/{id}/rotate

Rotate an API key

Mints a replacement owned by the same user and merchant, with the same access, and returns
it with its value revealed. This is the only time that value is shown.
            
The key being rotated keeps authenticating for an overlap window (24 hours by default,
seven days at most) so the integration can deploy the replacement without an outage, and
is then refused with KEY_REVOKED. To end the overlap sooner, revoke the rotated key: that
takes effect on the very next request.
            
Gated on the same permission as revoke, because it is the same decision about the same
credential. Refused for a key that has already been revoked or already been rotated.

**Operation ID:** `apiKeysRotate`

## Authorization

Requires: ApiKeyAuthorization.ApiKeys, merchant scope.

Required permissions:
- `ApiKeyAuthorization.ApiKeys`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: `RotateApiKeyDto`

Properties:
- `overlapHours` (integer(int32)): How many hours the replaced key should keep authenticating, or `null` for the configured  default (24 hours).
- `expireAt` (string(date-time)): When the replacement should expire, or `null` to give it the same term the replaced key  was originally granted, measured from now.
- `reason` (string): A reason recorded against the replaced key, used only when the rotation cuts over immediately  and therefore revokes it in the same operation.

**Content type:** `text/json`

Schema: `RotateApiKeyDto`

Properties:
- `overlapHours` (integer(int32)): How many hours the replaced key should keep authenticating, or `null` for the configured  default (24 hours).
- `expireAt` (string(date-time)): When the replacement should expire, or `null` to give it the same term the replaced key  was originally granted, measured from now.
- `reason` (string): A reason recorded against the replaced key, used only when the rotation cuts over immediately  and therefore revokes it in the same operation.

**Content type:** `application/*+json`

Schema: `RotateApiKeyDto`

Properties:
- `overlapHours` (integer(int32)): How many hours the replaced key should keep authenticating, or `null` for the configured  default (24 hours).
- `expireAt` (string(date-time)): When the replacement should expire, or `null` to give it the same term the replaced key  was originally granted, measured from now.
- `reason` (string): A reason recorded against the replaced key, used only when the rotation cuts over immediately  and therefore revokes it in the same operation.

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `ApiKeyRevealedDto`

Properties:
- `id` (string(uuid))
- `name` (string): Gets or sets the display name of the API key.
- `keyPrefix` (string): Gets or sets the leading characters of the key value, safe to display. `null` for a key  the rewrap backfill has not reached.
- `last4` (string): Gets or sets the trailing characters of the key value, safe to display. `null` for a key  the rewrap backfill has not reached.
- `environment` (object): Gets or sets which world the key acts in, or `null` when it has never been stamped.
- `status` (object): Gets or sets the key's administrative state.
- `maskedKey` (string): Gets the key's display form: its retained prefix, an ellipsis, and its last characters. This  is the only representation of the value any read path carries.
- `lastUsedAt` (string(date-time)): Gets or sets the UTC instant the key was last used to authenticate, or `null` when it  has no recorded use.
- `creationTime` (string(date-time)): Gets or sets the UTC instant the key was created.
- `merchantId` (string(uuid)): Gets or sets the merchant the key was minted for, or `null` when it is not tied to one.
- `active` (boolean): Gets or sets a value indicating whether the API key is active.
- `expireAt` (string(date-time)): Gets or sets the expiration date for the API key. Null indicates the key does not expire.
- `userId` (string(uuid)): Gets or sets the user ID that owns this API key.
- `replacesKeyId` (string(uuid)): Gets or sets the key this one was minted to replace, or `null` when it was not created  by a rotation.
- `replacedByKeyId` (string(uuid)): Gets or sets the key minted to replace this one, or `null` when it has not been rotated.
- `overlapExpiresAt` (string(date-time)): Gets or sets when this key's rotation overlap closes and it stops authenticating, or  `null` when it is not in one.
- `allowedCidrs` (array<string>): Gets or sets the source addresses this key may be used from, as CIDR ranges or bare  addresses, or `null` when it is not bound to any and may be used from anywhere.
- `scopes` (array<string>): Gets or sets the capability scopes this key is restricted to, or `null` when it is  unrestricted and may reach everything its owner can.
- `key` (string): Gets or sets the plaintext API key value. Shown once, at creation, and never again.
- `replacedKeyOverlapExpiresAt` (string(date-time)): Gets or sets when the key this one replaced stops authenticating, or `null` when this key  was not created by a rotation, or was created by one that cut over immediately.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a RotateApiKeyDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/api-keys/{id}/rotate" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "overlapHours": 0,
  "expireAt": "2026-01-01T00:00:00Z",
  "reason": ""
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "overlapHours": 0,
  "expireAt": "2026-01-01T00:00:00Z",
  "reason": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/api-keys/{id}/rotate' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, APIKeysApi } from '@winkpg/winkpg-api';

const api = new APIKeysApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.apiKeysRotate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "overlapHours": 0,
  "expireAt": "2026-01-01T00:00:00Z",
  "reason": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/api-keys/{id}/rotate', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "overlapHours": 0,
    "expireAt": "2026-01-01T00:00:00Z",
    "reason": ""
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new APIKeysApi(config);
var body = JsonSerializer.Deserialize<RotateApiKeyDto>("""
    {
      "overlapHours": 0,
      "expireAt": "2026-01-01T00:00:00Z",
      "reason": ""
    }
    """);

var result = await api.ApiKeysRotateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/api-keys/{id}/rotate");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "overlapHours": 0,
      "expireAt": "2026-01-01T00:00:00Z",
      "reason": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.APIKeysApi(client)
    body = winkpg_api.RotateApiKeyDto.from_dict({
      "overlapHours": 0,
      "expireAt": "2026-01-01T00:00:00Z",
      "reason": ""
    })
    result = api.api_keys_rotate("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "overlapHours": 0,
  "expireAt": "2026-01-01T00:00:00Z",
  "reason": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/api-keys/{id}/rotate",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.