Unkey · Schema

V2KeysMigrateKeysMigration

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
hash	string	The hash provided in the migration request
keyId	string	The unique identifier for this key in Unkey's system. This is NOT the actual API key, but a reference ID used for management operations like updating or deleting the key. Store this ID in your databas

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysMigrateKeysMigration",
  "title": "V2KeysMigrateKeysMigration",
  "type": "object",
  "required": [
    "hash",
    "keyId"
  ],
  "properties": {
    "hash": {
      "type": "string",
      "description": "The hash provided in the migration request",
      "example": "sha256_abc123def456"
    },
    "keyId": {
      "type": "string",
      "description": "The unique identifier for this key in Unkey's system. This is NOT the actual API key, but a reference ID used for management operations like updating or deleting the key. Store this ID in your database to reference the key later. This ID is not sensitive and can be logged or displayed in dashboards.",
      "example": "key_2cGKbMxRyIzhCxo1Idjz8q"
    }
  }
}