CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-03 21:01:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
0803a0daad
zulip/api_docs/api-keys.md

1.9 KiB
Raw Blame History

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

{start_tabs}

{tab|for-a-bot}

{settings_tab|your-bots}

  1. In the Actions column, click the manage bot () icon, and scroll down to API key.

  2. Click the copy () icon to copy the bot's API key to your clipboard.

!!! warn ""

Anyone with a bot's API key can impersonate the bot, so be careful with it!

{tab|for-yourself}

{settings_tab|account-and-privacy}

  1. Under API key, click Manage your API key.

  2. Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.

  3. Copy your API key.

!!! warn ""

Anyone with your API key can impersonate you, so be doubly careful with it.

{end_tabs}

Invalidate an API key

To invalidate an existing API key, you have to generate a new key.

{start_tabs}

{tab|for-a-bot}

{settings_tab|your-bots}

  1. In the Actions column, click the manage bot () icon, and scroll down to API key.

  2. Click the generate new API key () icon.

{tab|for-yourself}

{settings_tab|account-and-privacy}

  1. Under API key, click Manage your API key.

  2. Enter your password, and click Get API key. If you don't know your password, click reset it and follow the instructions from there.

  3. Click Generate new API key

{end_tabs}

Related articles