Delete Api Key

DELETE 
/keys/:key_prefix

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.

Request

Path Parameters

key_prefix Key Prefixrequired

Responses

200

Successful Response

application/json

Schema

Schema

object

Example (from schema)

{}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...