Skip to main content

API keys

An API key lets a script or the CLI use Termix as you.

Make one​

In Settings, API keys, press New Key. Give it a name, pick what it may do and, if you want, an expiry date. Copy the key right away. It is only shown once.

AccessWhat the key can do
Read onlyRead anything its user can read. It can't change anything.
Actions, read onlyList and run read only actions, and use MCP.
ActionsRun any action its user may run, and use MCP.
Full accessEverything its user can do.

A key made without picking is read only and works for 90 days. Pick full access and never expires on purpose when a script needs it. Keys made before Termix 26.11.2 keep the access they had.

Admins can also make keys for other users in Settings, API keys under This server, and revoke any key.

Use it​

Send it as a bearer token:

curl -H "Authorization: Bearer tmx_your_key" https://termix.example.com/host/db/host

A key never has more permissions than the user who owns it. It can't act as anyone else.

See the API reference for every route. Each plugin's routes are listed under that plugin.

Revoke​

Press Revoke next to a key. It stops working at once.

With the Login Security plugin, everyone can see the keys made for them in Sessions and keys, with when each was last used, and revoke one or all of them.