Headscale unofficial
POST/api/v1/node/{nodeId}/rename/{newName}

Rename a node

Renames a node by setting its new name. Supply the node identifier and the new name in the path.

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

2 parameters
nodeIdstringrequired
The node identifier, formatted as an unsigned 64-bit integer.
newNamestringrequired
The new name to assign to the node.

2 status codes
200Returns the renamed node record, including its updated name 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. The newName path parameter accepts a string containing the node's new name.