Headscale unofficial
POST/api/v1/node/{nodeId}/expire

Update node expiry

Updates the expiry settings for a node. Supply expiry as an ISO 8601 date-time or use disableExpiry to specify whether expiry is disabled.

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

1 parameter · 2 body fields
nodeIdstringrequired
The node identifier, formatted as an unsigned 64-bit integer.

Optional settings for changing or disabling node expiry.

disableExpirybooleanoptional
Whether to disable expiry for the node.
expirystringoptional
The node expiry time in ISO 8601 date-time format.

2 status codes
200Returns the updated node record, including its expiry and other node details.
nodeobjectrequired
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 nodeId path parameter must be a string in unsigned 64-bit integer format. If supplied, expiry must use ISO 8601 date-time format, and disableExpiry must be a boolean.