Get a node | Headscale unofficial

1 parameter

nodeIdstringrequired

The node identifier, formatted as an unsigned 64-bit integer.

2 status codes

200Returns the 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 nodeId path parameter must be a string in unsigned 64-bit integer format and identify the node to retrieve.

import { Client } from "headscale-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.node.get({ nodeId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "node": {
    "approvedRoutes": [
      "example_value"
    ],
    "availableRoutes": [
      "example_value"
    ],
    "createdAt": "2026-01-15T09:00:00Z",
    "discoKey": "example_key_abc123",
    "expiry": "2026-01-15T09:00:00Z",
    "givenName": "Example Name",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "ipAddresses": [
      "example_value"
    ],
    "lastSeen": "2026-01-15T09:00:00Z",
    "machineKey": "example_key_abc123",
    "name": "Example Name",
    "nodeKey": "example_key_abc123",
    "online": true,
    "preAuthKey": {
      "aclTags": [
        "example_value"
      ],
      "createdAt": "2026-01-15T09:00:00Z",
      "ephemeral": true,
      "expiration": "2026-01-15T09:00:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "example_key_abc123",
      "reusable": true,
      "used": true,
      "user": {
        "createdAt": "2026-01-15T09:00:00Z",
        "displayName": "Example Name",
        "email": "user@example.com",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "profilePicUrl": "https://example.com",
        "provider": "Example Academy Trust",
        "providerId": "550e8400-e29b-41d4-a716-446655440000"
      }
    },
    "registerMethod": "REGISTER_METHOD_UNSPECIFIED",
    "subnetRoutes": [
      "example_value"
    ],
    "tags": [
      "example_value"
    ],
    "user": {
      "createdAt": "2026-01-15T09:00:00Z",
      "displayName": "Example Name",
      "email": "user@example.com",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "profilePicUrl": "https://example.com",
      "provider": "Example Academy Trust",
      "providerId": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
}

Request

Response

Errors