zulip/templates/zerver/api/dev-fetch-api-key.md
shanukun be39672026 api_docs: Document the /fetch-api-key endpoint.
With tweaks by tabbott to document addition details.

Fixes: #16408.
2020-11-02 16:45:42 -08:00

528 B

Fetch an API key (development only)

{generate_api_description(/dev_fetch_api_key:post)}

Usage examples

{start_tabs} {tab|curl}

{generate_code_example(curl)|/dev_fetch_api_key:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/dev_fetch_api_key:post}

Response

Return values

{generate_return_values_table|zulip.yaml|/dev_fetch_api_key:post}

Example response

A typical successful JSON response may look like:

{generate_code_example|/dev_fetch_api_key:post|fixture(200)}