Sign in

v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
apis

Delete API namespace

Permanently delete an API namespace and immediately invalidate all associated keys.

Use this for cleaning up development environments, retiring deprecated services, or removing unused resources. All keys in the namespace are immediately marked as deleted and will fail verification with code=NOT_FOUND.

Important: This operation is immediate and permanent. Verify you have the correct API ID before deletion. If delete protection is enabled, disable it first through the dashboard or API configuration.

Required Permissions

Your root key must have one of the following permissions:

  • api.*.delete_api (to delete any API)
  • api.<api_id>.delete_api (to delete a specific API)
post/v2/apis.deleteApi

Request body

apiIdstring required

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 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.

Example request

{
  "apiId": "api_1234abcd"
}

Response

API namespace deleted successfully. All associated keys are immediately invalidated and will fail verification with code=NOT_FOUND.

dataEmptyResponse required

Empty response object by design. A successful response indicates this operation was successfully executed.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}