A service account is a login for software rather than a person. Pickaxe uses its token to connect to Foreman. Using a service account instead of someone's personal API key means Pickaxe keeps working if that person leaves or their access changes.
Before You Start
- You need the Admin role or the Manage Users permission.
- Switch to the client the Pickaxe will report to. Service accounts belong to a client.
Create the Service Account
- Open the user menu (top right) and select Users.
- Open the Service Accounts tab and click Add Service Account.
- Enter a name you'll recognize, such as "Pickaxe – Site 1".
- Assign the Admin role. Pickaxe uses this account both to report stats and to carry out the commands you send to miners.
- Save.
Get the Token
- On the Service Accounts tab, open the account's Actions menu and choose View Token.
- Copy the token and store it securely, for example in a password manager.
- Use it as the API key when you install Pickaxe. See How To: Install Pickaxe.
Manage Service Accounts
- Edit changes the account's roles.
- Reset Token, in the token window, issues a new token. Any Pickaxe using the old token stops connecting until you update it with the new one.
- Delete removes the account. Any Pickaxe using it goes offline.
Things to Know
- Use one service account per site or Pickaxe group, so you can reset one token without affecting other sites.
- Treat the token like a password. Anyone with it can act on your client through the API.
Related Articles
Last verified: November 19, 2026