List pre-auth keys | Headscale unofficial

2 status codes

200Returns an object containing a `preAuthKeys` array of pre-auth key records, including each key's user, identifier, value, reuse and ephemeral settings, usage state, expiration, creation time, and ACL tags.

preAuthKeysarray<object>required

defaultReturned when the request fails; includes a problem details object with information about the error.

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

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.preauthkey.list();

{
  "preAuthKeys": [
    {
      "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"
      }
    }
  ]
}

Response