Headscale unofficial
POST/api/v1/auth/register

Register a node through the authentication flow

Registers a node through the authentication flow. Use authId to associate the registration with an authentication session and user to specify the user for the node. The response contains the registered node.

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

2 body fields

Authentication flow details used to register a node.

authIdstringoptional
The identifier of the authentication session associated with the registration.
userstringoptional
The user associated with the node.

2 status codes
200Returns an object containing the registered node, including its identifiers, keys, addresses, user, status, and route 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

If provided, authId and user must be strings. The schema does not require either field in the request body.