Headscale unofficial
DELETE/api/v1/apikey/{prefix}

Delete an API key

Deletes an API key selected by its prefix. You can also supply id as a uint64-formatted string to further identify the key. The response confirms the operation with an empty object.

2 parameters
prefixstringrequired
The prefix of the API key to delete.
idstringoptional
An API key identifier in uint64 format that can be used to identify the key.

2 status codes
200Returns an empty JSON object.
defaultError
detailstringoptional
A human-readable explanation specific to this occurrence of the problem.
errorsarray<object>optional
Optional list of individual error details
instancestringoptional
A URI reference that identifies the specific occurrence of the problem.
statusintegeroptional
HTTP status code
titlestringoptional
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestringoptional
A URI reference to human-readable documentation for the error.
Default:about:blank

Error handling

The prefix path parameter is a string identifying the API key. If supplied, the id query parameter must be a uint64-formatted string.