Skip to content

Import Api Keys

apigateway_import_api_keys R Documentation

Import API keys from an external source, such as a CSV-formatted file

Description

Import API keys from an external source, such as a CSV-formatted file.

Usage

apigateway_import_api_keys(body, format, failOnWarnings)

Arguments

body

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

format

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

failOnWarnings

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

Value

A list with the following syntax:

list(
  ids = list(
    "string"
  ),
  warnings = list(
    "string"
  )
)

Request syntax

svc$import_api_keys(
  body = raw,
  format = "csv",
  failOnWarnings = TRUE|FALSE
)