Skip to content

ImportApiKeysRequest

Source code in docs_src/capo_api_gateway/types/import_api_keys_request.py
class ImportApiKeysRequest(TypedDict, closed=True):
    body: "capo_api_gateway.types.blob.Blob"
    """<p>The payload of the POST request to import API keys. For the payload format, see API Key File Format.</p>"""
    format: "capo_api_gateway.types.api_keys_format.ApiKeysFormat"
    """<p>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</p>"""
    fail_on_warnings: "capo_api_gateway.types.boolean.Boolean"
    """<p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>"""

body instance-attribute

body: Blob

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

fail_on_warnings instance-attribute

fail_on_warnings: Boolean

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

format instance-attribute

format: ApiKeysFormat

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.