# GET /api/api-keys/{id}/detail Get an API key's details Return the metadata and lifecycle state of an API key with the given id. The key value is never included: it is returned only once, when the key is created. Resolves for the key's owner or an admin; any other caller gets the same 404 as a key that does not exist. **Operation ID:** `apiKeysGetDetail` ## Authorization Requires: ApiKeyAuthorization.ApiKeys, merchant scope. Requires API key scope: `admin` 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. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`ApiKeyDetailDto`](https://devportal.demo.winkpg.io/docs/api/models/ApiKeyDetailDto.md) Properties: - `id` (string(uuid)) - `name` (string): Gets or sets the display name of the API key. (nullable) - `active` (boolean): Gets or sets a value indicating whether the API key is marked active. An inactive key is rejected at authentication regardless of its expiry. - `expireAt` (string(date-time)): Gets or sets the expiration date for the API key. Null indicates the key does not expire. (nullable) - `userId` (string(uuid)): Gets or sets the user ID that owns this API key. - `keyPrefix` (string): Gets or sets the leading characters of the key value, safe to display. `null` for a key minted before hashed storage that the rewrap has not reached. (nullable) - `last4` (string): Gets or sets the trailing characters of the key value, safe to display. `null` for a key the rewrap has not reached. (nullable) - `environment` ([ApiKeyEnvironment](https://devportal.demo.winkpg.io/docs/api/models/ApiKeyEnvironment.md)): Gets or sets which world the key acts in, or `null` when it has never been stamped. (nullable) Values: - `Test`: The key acts against the processor's test host. No live money moves. Minted with the sk_test_ prefix. - `Live`: The key acts against the processor's live host. Minted with the sk_live_ prefix. - `status` ([ApiKeyStatus](https://devportal.demo.winkpg.io/docs/api/models/ApiKeyStatus.md)): Gets or sets the key's administrative state. Resolved at the projection boundary, so a key that predates the field arrives as `Active` rather than unset. Values: - `Active`: The key is in service. Whether it is currently accepted also depends on its expiry. - `Revoked`: The key has been revoked and is rejected at authentication for good. Revoked keys are retained rather than deleted so the audit trail of what the key did survives it. - `Suspended`: The key has been put out of service temporarily, pending someone deciding whether the use that triggered it was legitimate. Rejected at authentication exactly as a revoked key is, and reinstatable, which is the whole reason it is not one. - `revokedAt` (string(date-time)): Gets or sets when the key was revoked, or `null` if it has not been. (nullable) - `revokedBy` (string(uuid)): Gets or sets who revoked the key, or `null` if it has not been revoked. (nullable) - `revocationReason` (string): Gets or sets the reason recorded at revocation, when one was given. (nullable) - `suspendedAt` (string(date-time)): Gets or sets when the key was suspended, or `null` when it is not suspended. (nullable) - `suspendedBy` (string(uuid)): Gets or sets who suspended the key, or `null` when the platform did or the key is not suspended. Read alongside `suspensionReason`, which says which of the two a null means. (nullable) - `suspensionReason` (string): Gets or sets why the key was suspended, when it is. (nullable) - `anomalySourceAction` ([ApiKeyAnomalyAction](https://devportal.demo.winkpg.io/docs/api/models/ApiKeyAnomalyAction.md)): Gets or sets this key's own action for an anomalous source, or `null` when it follows the merchant default. (nullable) Values: - `LogOnly`: Write the detection to the security log and the metrics and do nothing else. The default, and what a deployment should stay on until its own traffic has been looked at. - `Notify`: Log it and tell the key's owner. The key keeps working: the person who can tell a new office from a stolen credential is the one holding it, so this asks them rather than deciding. - `Suspend`: Log it, tell the owner, and put the key into Suspended so it stops authenticating until somebody reinstates it. Containment ahead of confirmation, which is the right trade only for a merchant that has decided a stalled integration costs less than a credential in the wrong hands. - `merchantId` (string(uuid)): Gets or sets the merchant this key was minted for, or `null` when it is not tied to one. (nullable) - `replacesKeyId` (string(uuid)): Gets or sets the key this one was minted to replace, or `null` when it was not created by a rotation. (nullable) - `replacedByKeyId` (string(uuid)): Gets or sets the key minted to replace this one, or `null` when it has not been rotated. (nullable) - `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. Retained after the key is revoked, because the lineage is history. (nullable) - `isRevoked` (boolean): Gets a value indicating whether the key has been revoked. (read only) - `isSuspended` (boolean): Gets a value indicating whether the key is suspended, which is reversible, as opposed to revoked, which is not. (read only) - `isInRotationOverlap` (boolean): Gets a value indicating whether this key is currently inside a rotation overlap: rotated, still in service, and not yet past the window. (read only) - `hasRotationLineage` (boolean): Gets a value indicating whether this key was minted as a replacement for an earlier one, or has itself been replaced. Either makes it part of a rotation chain worth showing. (read only) - `creationTime` (string(date-time)): Gets or sets the UTC time the key was created. - `lastModificationTime` (string(date-time)): Gets or sets the UTC time the key record was last modified, when it has been modified. (nullable) - `lastUsedAt` (string(date-time)): Gets or sets the UTC time the key was last used to authenticate a request, or `null` when it has no recorded use. Covers every kind of API activity, not just transactions. (nullable) - `recentSourceIps` (array<[ApiKeySourceIpDto](https://devportal.demo.winkpg.io/docs/api/models/ApiKeySourceIpDto.md)>): Gets or sets the addresses the key has recently authenticated from, most recently seen first. Empty when none have been recorded. (nullable) Fields of each item: - `address` (string): Gets or sets the address, as the request pipeline resolved it. (nullable) - `firstSeenAt` (string(date-time)): Gets or sets the UTC time this address was first recorded for the key. - `lastSeenAt` (string(date-time)): Gets or sets the UTC time this address was most recently recorded for the key. - `allowedCidrs` (array): Gets or sets the source addresses this key is permitted to authenticate from, as CIDR ranges or bare addresses. Empty means the key is not bound to any and may be used from anywhere. (nullable) - `isAddressRestricted` (boolean): Gets a value indicating whether the key is bound to a set of source addresses. (read only) - `scopes` (array): Gets or sets the capability scopes this key is restricted to. Empty means the key is unrestricted and may reach everything its owning account can. (nullable) - `isScopeRestricted` (boolean): Gets a value indicating whether the key is restricted to a set of capability scopes. (read only) - `isExpired` (boolean): Gets a value indicating whether the key's expiry has already passed. A key with no expiry never reports as expired. (read only) - `hasRotationOverlapLapsed` (boolean): Gets a value indicating whether the key's rotation overlap has closed, so it is refused at authentication even while its stored status still reads active. (read only) - `isUsable` (boolean): Gets a value indicating whether the key would currently be accepted at authentication: in service, marked active, not past its expiry, and not past a rotation overlap. (read only) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/api-keys/{id}/detail" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/api-keys/{id}/detail' ` -Headers $headers ``` ### 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.apiKeysGetDetail("3fa85f64-5717-4562-b3fc-2c963f66afa6"); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/api-keys/{id}/detail', { method: 'GET', headers: { "api-key": "{{API_KEY}}", }, }); 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; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new APIKeysApi(config); var result = await api.ApiKeysGetDetailAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6")); ``` ### C# (raw HTTP) ```csharp using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/api-keys/{id}/detail"); request.Headers.Add("api-key", "{{API_KEY}}"); 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) result = api.api_keys_get_detail("3fa85f64-5717-4562-b3fc-2c963f66afa6") ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "GET", "{{BASE_URL}}/api/api-keys/{id}/detail", headers=headers, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.