API keys

Settings › API keys lets a script or another app use the Solel API as you, such as a backup script or a home automation hub.

Make a key

1. Choose New key.
2. Name it after what will use it, such as Backups.
3. Under What it may do, tick only what it needs. You're only offered what your own account can do.
4. Choose how long it Works for: 30 days, 90 days, 6 months or 1 year. It starts at 90 days.
5. Enter your password and choose Make key.
6. Copy the key now. This is the only time it's shown. If you lose it, revoke it and make another.

What a key can do

The permissions run from using your own apps and sharing at home, through making public links, talking to Jethro and your other Sols for you, and installing apps, to managing people, running the server and reading the activity log. Each one says what it allows, in a line under its name.

A key can only do what you choose for it, and never more than you can. Keys can't change passwords, sign-in or other keys, can't make sync passwords for phones, and never get Terminal or private access.

Use a key

Send it as a bearer token. With the key in SOLEL_KEY and your server's address in place of home.example.com:

curl -H "Authorization: Bearer $SOLEL_KEY" https://home.example.com/api/me

Once you have a key, the page shows this line with your own server's address.

Your keys

Each key shows the start of its value, when it expires, how many permissions it has and when it was last used. Expired keys are marked. Revoke… stops anything using a key straight away, and can't be undone.

Signing out everywhere revokes all your keys, and so does an admin resetting your password or turning your account off.