Keys

Delete Api Key

Changed on

Delete an API key with the given key prefix for the authenticated user.

Args: key_prefix (str): The prefix of the API key to be deleted. request (Request): The incoming request object.

Returns: dict: A dictionary containing a success message upon successful deletion.

Raises: HTTPException: If the API key is not found or does not belong to the user.

delete/keys/{key_prefix}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/keys/{key_prefix}
  • Auth
    API key in header Authorization

Path parameters

key_prefixstring required

Response

Successful Response

object required

Changes

  • 6e37373d45feRevision changes
    • info

      api tag Keys added

    • info

      api tag Api Keys removed

  • 72fe88316d15Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status