Unkey · Schema

V2KeysMigrateKeysRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
migrationId string Identifier of the configured migration provider/strategy to use (e.g., "your_company"). You will receive this from Unkey's support staff.
apiId string The ID of the API that the keys should be inserted into
keys array
View JSON Schema on GitHub

JSON Schema

unkey-v2keysmigratekeysrequestbody-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2KeysMigrateKeysRequestBody",
  "title": "V2KeysMigrateKeysRequestBody",
  "type": "object",
  "properties": {
    "migrationId": {
      "type": "string",
      "minLength": 3,
      "maxLength": 255,
      "description": "Identifier of the configured migration provider/strategy to use (e.g., \"your_company\"). You will receive this from Unkey's support staff.",
      "example": "your_company"
    },
    "apiId": {
      "type": "string",
      "minLength": 3,
      "maxLength": 255,
      "description": "The ID of the API that the keys should be inserted into",
      "example": "api_123456789"
    },
    "keys": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/V2KeysMigrateKeyData"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "migrationId",
    "apiId",
    "keys"
  ]
}