3c0cb4c6a2
- Updates API docs that have numbered instructions to use the
`{start_tabs}` formatting we use in the help center.
- Cleans up formatting and revises documentation that shouldn't
be formatted as a numbered instructions block.
- Cross-links related articles.
Fixes #28876.
1.8 KiB
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 a bot's API key
{start_tabs}
{tab|desktop-web}
{settings_tab|your-bots}
-
Click Active bots.
-
Find your bot. The bot's API key is under API KEY.
{end_tabs}
!!! warn ""
Anyone with a bot's API key can impersonate the bot, so be careful with it!
Get your API key
{start_tabs}
{tab|desktop-web}
{settings_tab|account-and-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.
{end_tabs}
!!! warn ""
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.
Invalidate a bot's API key
{start_tabs}
{tab|desktop-web}
{settings_tab|your-bots}
-
Click Active bots.
-
Find your bot.
-
Under API KEY, click the refresh () icon to the right of the bot's API key.
{end_tabs}
Invalidate your API key
{start_tabs}
{tab|desktop-web}
{settings_tab|account-and-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
{end_tabs}