POST

/apikeys#mode=import&format

http://apigateway.{region}.amazonaws.com/apikeys#mode=import&format

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

Access Token Required: API Key

Query Params

formatstringrequired

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

Allowed:

failonwarningsboolean

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

modestringrequired

Allowed:

Body Params

bodystringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/apikeys#mode=import&format' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}