Headscale unofficial
POST/api/v1/preauthkey/expire

Expire a pre-auth key

Expires a pre-auth key. Supply its identifier in the id field as a uint64-formatted string when specifying which key to expire.

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

1 body field

Pre-auth key expiration request.

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

2 status codes
200Returns an empty object when the expiration 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 request body is required, but id is not marked as a required field. When supplied, id must be a uint64-formatted string.