API keys
An API key is how a bot identifies itself to Zulip. For the official
clients, such as the Python bindings, we recommend downloading a zuliprc
file. This file
contains an API key and other necessary configuration values for using the
Zulip API with a specific account on a Zulip server.
Get API key
-
Click on the gear () icon in the upper
right corner of the web or desktop app.
-
Select Personal settings.
-
On the left, click Bots.
-
In the Actions column, click the manage bot
() icon,
and scroll down to API key.
-
Click the copy
() icon to
copy the bot's API key to your clipboard.
Anyone with a bot's API key can impersonate the bot, so be careful with it!
-
Click on the gear () icon in the upper
right corner of the web or desktop app.
-
Select Personal settings.
-
On the left, click Account & privacy.
-
Under API key, click Manage your API key.
-
Enter your password, and click Get API key. If you don't know your
password, click reset it and follow the instructions from there.
-
Copy your API key.
Anyone with your API key can impersonate you, so be doubly careful with it.
Invalidate an API key
To invalidate an existing API key, you have to generate a new key.
-
Click on the gear () icon in the upper
right corner of the web or desktop app.
-
Select Personal settings.
-
On the left, click Bots.
-
In the Actions column, click the manage bot
() icon,
and scroll down to API key.
-
Click the generate new API key
() icon.
-
Click on the gear () icon in the upper
right corner of the web or desktop app.
-
Select Personal settings.
-
On the left, click Account & privacy.
-
Under API key, click Manage your API key.
-
Enter your password, and click Get API key. If you don't know your
password, click reset it and follow the instructions from there.
-
Click Generate new API key
Related articles