Headscale unofficial
POST/api/v1/apikey/expire

Expire an API key

Expires an API key. Identify the key using id, prefix, or both, according to the key details available to you. The response confirms the operation with an empty object.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

API key identifier fields used to select the key to expire.

idstringoptional
The API key identifier as a uint64-formatted string.
prefixstringoptional
The API key prefix.

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

If provided, id must be a uint64-formatted string, and prefix must be a string. The schema does not require either field.