{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Restapis#mode=import API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Restapis#mode=import", "type": "folder" }, "items": [ { "info": { "name": "ImportRestApi", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/restapis#mode=import", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "failonwarnings", "value": "", "type": "query", "description": "A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false." }, { "name": "parameters", "value": "", "type": "query", "description": "

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

" }, { "name": "mode", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A feature of the API Gateway control service for creating a new API from an external API definition file." } ] } ], "bundled": true }