paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 08:33:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b919dfd48944b860ebe43d0a6d6a43861f1ea081
zulip/api_docs/api-keys.md
Lauryn Menard dbacc00f0f api-docs: Move markdown files to top level directory. 
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
  markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
  hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
2023-02-02 17:25:40 -08:00

932 B
Raw Blame History

API keys

An API key is how a bot identifies itself to Zulip. Anyone with a bot's API key can impersonate the bot, so be careful with it!

Get a bot's API key

{settings_tab|your-bots}

  1. Click Active bots.

  2. Find your bot. The bot's API key is under API KEY.

Get your API key

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

{settings_tab|account-and-privacy}

  1. Under API key, click Show/change your API key.

  2. Enter your password, and click Get API key. If you never had a password, click Never had one? Forgotten it? and follow the instructions from there.

  3. Copy your API key.

Invalidate an API key

To invalidate a key, follow the instructions above, and click Generate new API key or click the refresh () icon as appropriate.

This will generate a new key for you or the bot, and invalidate the old one.