Unkey · Schema

V2KeysWhoamiRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
key	string	The complete API key string provided by you, including any prefix. Never log, cache, or store API keys in your system as they provide full access to user resources. Include the full key exactly as pro

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysWhoamiRequestBody",
  "title": "V2KeysWhoamiRequestBody",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "The complete API key string provided by you, including any prefix.\nNever log, cache, or store API keys in your system as they provide full access to user resources.\nInclude the full key exactly as provided - even minor modifications will cause a not found error.\n",
      "example": "sk_1234abcdef5678"
    }
  },
  "additionalProperties": false,
  "required": [
    "key"
  ]
}