UseAccount
Personal API keys
Create an API key so a program can use the platform for you, copy it, and delete it when you stop using it.
This page helps you create an API key so a program or script can use the platform for you, without your password. Whoever has the key can do everything the key allows, so keep it secret like a password.
Create a key
- Open Account, click API keys, then click Add API key.
- Type a Name that tells you which program uses this key.
- If you want the key to expire, click Expires, pick a day, and click OK. If you leave it as Never, the key works indefinitely.
- Under Scopes, tick only what the program needs. See Choose scopes.
- For Restriction type, choose None.
- Click Save.
After you save, the Key field shows your new key.
Choose scopes
The scope text is in English. Each one means:
| Scope | What the key can do |
|---|---|
| Read any public content | Read Items that are public |
| Read any items there owned by and shared with user | Read your Items, and Items others shared with you |
| Manage any items there owned by and shared with user | Edit your Items, and Items others shared with you |
| Read any groups where user are owned and joined | Read groups you own or belong to |
| Manage any groups where user are owned and joined | Edit groups you own or belong to |
Copy a key
- In the list, click Edit on the key.
- Click the copy icon in the Key field.
- Paste the key into the program that will use it.
Delete a key
- In the list, click Delete on the key.
- Click Delete again to confirm.
Programs using this key stop working at once.
Other cases
- If a key has expired, click Edit, change the day in Expires, and click Save. The key itself does not change.
- If you choose another Restriction type, such as IP address, this does not yet stop the key from being used from elsewhere. Limit the key with Scopes and Expires instead.
- If the Delete button is dimmed, this key cannot be deleted.