Headscale unofficial
POST/api/v1/debug/node

Create a node for debugging

Creates a node for debugging purposes. Provide name and user to describe the node, and use key or routes when those values are needed for the test setup. The response contains the created node.

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

4 body fields

Optional node values for a debugging setup.

keystringoptional
The key value to use for the node.
namestringoptional
The node name.
routesarray<string>optional
The routes to associate with the node, as an array of strings.
userstringoptional
The user associated with the node.

2 status codes
200Returns an object containing the created 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, key, name, and user must be strings. routes must be an array of strings, and the schema does not require any of these fields.