Headscale unofficial
POST/api/v1/node/register

Register a node

Registers a node and returns its node record. Use user to associate the node with a user and key to provide a registration key when needed.

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

2 parameters
userstringoptional
The user associated with the node.
keystringoptional
The registration key to use when registering the node.

2 status codes
200Returns the registered node record, including its identifiers, keys, IP addresses, user, registration details, and status.
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 user query parameter and key query parameter accept string values. Provide the appropriate values to identify the user and registration key for the node.