Headscale unofficial
DELETE/api/v1/preauthkey

Delete a pre-auth key

Deletes a pre-auth key. Use the optional id query parameter to identify the key to delete; provide it as a uint64-formatted string when supplied.

1 parameter
idstringoptional
The identifier of the pre-auth key to delete, as a uint64-formatted string.

2 status codes
200Returns an empty object when the delete operation completes.
defaultReturned when the request fails; includes a problem details object with information about the error.
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 id query parameter, when supplied, must be a uint64-formatted string. The parameter is optional, and the API specification does not define behavior for omitting it.