# POST /api/api-keys/reveal

CreateAndReveal for ApiKeys

Performs CreateAndReveal operation on ApiKeys resource via POST method.

**Operation ID:** `apiKeysCreateAndReveal`

## Authorization

Requires: ApiKeyAuthorization.ApiKeys, merchant scope.

Required permissions:
- `ApiKeyAuthorization.ApiKeys`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

Schema: `ApiKeyCreateDto`

Properties:
- `name` (string) required: A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service')
- `active` (boolean): Whether the key should be active upon creation. Inactive keys cannot authenticate.
- `expireAt` (string(date-time)): Optional UTC timestamp after which the key is considered expired and rejected
- `allowedCidrs` (array<string>): Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or  IPv6 addresses. `null` or empty means the key is not bound to any address and may be  used from anywhere, which is the default and what every existing key carries.
- `scopes` (array<string>): Gets or sets the capability scopes this key is restricted to. `null` or empty means the  key is unrestricted, which is the default and what every existing key carries.
- `key` (string): The raw API key value to be created/registered. If omitted, the server may generate it.
- `userId` (string(uuid)): Identifier of the user (or owner) the key belongs to

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

Schema: `ApiKeyCreateDto`

Properties:
- `name` (string) required: A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service')
- `active` (boolean): Whether the key should be active upon creation. Inactive keys cannot authenticate.
- `expireAt` (string(date-time)): Optional UTC timestamp after which the key is considered expired and rejected
- `allowedCidrs` (array<string>): Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or  IPv6 addresses. `null` or empty means the key is not bound to any address and may be  used from anywhere, which is the default and what every existing key carries.
- `scopes` (array<string>): Gets or sets the capability scopes this key is restricted to. `null` or empty means the  key is unrestricted, which is the default and what every existing key carries.
- `key` (string): The raw API key value to be created/registered. If omitted, the server may generate it.
- `userId` (string(uuid)): Identifier of the user (or owner) the key belongs to

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

Schema: `ApiKeyCreateDto`

Properties:
- `name` (string) required: A human-friendly name/label to identify the key (e.g., 'CI Pipeline', 'Backend Service')
- `active` (boolean): Whether the key should be active upon creation. Inactive keys cannot authenticate.
- `expireAt` (string(date-time)): Optional UTC timestamp after which the key is considered expired and rejected
- `allowedCidrs` (array<string>): Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or  IPv6 addresses. `null` or empty means the key is not bound to any address and may be  used from anywhere, which is the default and what every existing key carries.
- `scopes` (array<string>): Gets or sets the capability scopes this key is restricted to. `null` or empty means the  key is unrestricted, which is the default and what every existing key carries.
- `key` (string): The raw API key value to be created/registered. If omitted, the server may generate it.
- `userId` (string(uuid)): Identifier of the user (or owner) the key belongs to

## 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 ApiKeyCreateDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/api-keys/reveal" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": ""
}'
```

### PowerShell

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

$body = @'
{
  "name": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/api-keys/reveal' `
    -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.apiKeysCreateAndReveal({
  "name": ""
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/api-keys/reveal', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": ""
  }),
});

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<ApiKeyCreateDto>("""
    {
      "name": ""
    }
    """);

var result = await api.ApiKeysCreateAndRevealAsync(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/reveal");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": ""
    }
    """, 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.ApiKeyCreateDto.from_dict({
      "name": ""
    })
    result = api.api_keys_create_and_reveal(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "name": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/api-keys/reveal",
    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.