List API keys | Headscale unofficial

2 status codes

200Returns an `apiKeys` array containing API key objects with their identifiers, prefixes, expiration times, creation times, and last-seen times.

apiKeysarray<object>required

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

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

{
  "apiKeys": [
    {
      "createdAt": "2026-01-15T09:00:00Z",
      "expiration": "2026-01-15T09:00:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "lastSeen": "2026-01-15T09:00:00Z",
      "prefix": "example_value"
    }
  ]
}