Unkey · Schema

V2ApisDeleteApiRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
apiId string Specifies which API namespace to permanently delete from your workspace. Must be a valid API ID that begins with 'api_' and exists within your workspace. Before proceeding, ensure you have the correct
View JSON Schema on GitHub

JSON Schema

unkey-v2apisdeleteapirequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2ApisDeleteApiRequestBody",
  "title": "V2ApisDeleteApiRequestBody",
  "type": "object",
  "required": [
    "apiId"
  ],
  "properties": {
    "apiId": {
      "type": "string",
      "minLength": 8,
      "maxLength": 255,
      "pattern": "^[a-zA-Z0-9_]+$",
      "description": "Specifies which API namespace to permanently delete from your workspace.\nMust be a valid API ID that begins with 'api_' and exists within your workspace.\n\nBefore proceeding, ensure you have the correct API ID and understand that this action cannot be undone. If you need to migrate functionality, create replacement keys in a new API namespace and update client applications before deletion.\n",
      "example": "api_1234abcd"
    }
  },
  "additionalProperties": false
}