KeyOps
Defined in: packages/core/src/ops.ts:73
Methods
Section titled “Methods”create()
Section titled “create()”create(
options):Promise<AuthKey>
Defined in: packages/core/src/ops.ts:89
Issues an auth key. The secret is returned once and never again.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<AuthKey>
Remarks
Section titled “Remarks”Risk: write. Anyone holding the secret can add a machine to the tailnet with the key’s tags.
fetch()
Section titled “fetch()”fetch(
userId?):Promise<AuthKey[]>
Defined in: packages/core/src/ops.ts:80
Lists auth keys.
Parameters
Section titled “Parameters”userId?
Section titled “userId?”string
Required by Headscale, which scopes keys per user. Ignored by Tailscale.
Returns
Section titled “Returns”Promise<AuthKey[]>
revoke()
Section titled “revoke()”revoke(
key):Promise<void>
Defined in: packages/core/src/ops.ts:101
Revokes a key.
Takes the whole key because the two control planes identify keys differently: Tailscale by id, Headscale by owner plus secret.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: write. Machines already registered stay on the tailnet; only new registrations are blocked.