Skip to main content
Docs

delete()

Warning

API keys is currently in beta. The API may change before general availability.

Deletes an API key by its ID. Returns a DeletedObjectResourceJavaScript Icon object.

function delete(apiKeyId: string): Promise<DeletedObjectResource>

Parameters

  • Name
    apiKeyId
    Type
    string
    Description

    The ID of the API key to delete.

Example

Note

Using clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const apiKeyId = 'apikey_123'

const response = await clerkClient.apiKeys.delete(apiKeyId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/api_keys/{apiKeyID}. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on