ImportRestApi - Amazon API Gateway


A feature of the API Gateway control service for creating a new API from an external API definition file.

Request Syntax

POST /restapis?mode=import&parameters&failonwarnings=failOnWarnings HTTP/1.1 body

URI Request Parameters

The request uses the following URI parameters.


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.


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.

Request Body

The request accepts the following binary data.


The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "apiKeySource": "string", "binaryMediaTypes": [ "string" ], "createdDate": number, "description": "string", "disableExecuteApiEndpoint": boolean, "endpointConfiguration": { "types": [ "string" ], "vpcEndpointIds": [ "string" ] }, "id": "string", "minimumCompressionSize": number, "name": "string", "policy": "string", "rootResourceId": "string", "tags": { "string" : "string" }, "version": "string", "warnings": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.


The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Type: String



The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Type: Array of strings


The timestamp when the API was created.

Type: Timestamp


The API's description.

Type: String


Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region} endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Type: Boolean


The endpoint configuration of this RestApi showing the endpoint types of the API.

Type: EndpointConfiguration object


The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Type: String


A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Type: Integer


The API's name.

Type: String


A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Type: String


The API's root resource ID.

Type: String


The collection of tags. Each tag element is associated with a given resource.

Type: String to string map


A version identifier for the API.

Type: String


The warning messages reported when failonwarnings is turned on during API import.

Type: Array of strings


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409


The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Import an OpenAPI API definition

This example illustrates one usage of ImportRestApi.

Sample Request

POST /restapis?mode=import&failonwarning=true&basepath=ignore HTTP/1.1 Content-Type: application/json Host: X-Amz-Date: 20160606T234936Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160606/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash} { "swagger": "2.0", "info": { "version": "2016-06-06T23:48:44Z", "title": "my-sample-api" }, "host": "", "basepath": "/stage2", "schemes": [ "https" ], "paths": { "/": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Empty" }, "headers": { "Content-Type": { "type": "string" } } } }, "x-amazon-apigateway-integration": { "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "responses": { "default": { "statusCode": "200", "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" } } }, "requestTemplates": { "application/json": "{\n}" }, "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "passthroughBehavior": "when_no_match", "httpMethod": "POST", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "type": "aws" } } } }, "definitions": { "Empty": { "type": "object" } } }

Sample Response

{ "_links": { "curies": [ { "href": "{rel}.html", "name": "authorizer", "templated": true }, { "href": "{rel}.html", "name": "deployment", "templated": true }, { "href": "{rel}.html", "name": "model", "templated": true }, { "href": "{rel}.html", "name": "resource", "templated": true }, { "href": "{rel}.html", "name": "restapi", "templated": true }, { "href": "{rel}.html", "name": "stage", "templated": true } ], "self": { "href": "/restapis/wn611yeyp3" }, "authorizer:by-id": { "href": "/restapis/wn611yeyp3/authorizers/{authorizer_id}", "templated": true }, "authorizer:create": { "href": "/restapis/wn611yeyp3/authorizers" }, "deployment:by-id": { "href": "/restapis/wn611yeyp3/deployments/{deployment_id}{?embed}", "templated": true }, "deployment:create": { "href": "/restapis/wn611yeyp3/deployments" }, "model:by-name": { "href": "/restapis/wn611yeyp3/models/{model_name}?flatten=false", "templated": true }, "model:create": { "href": "/restapis/wn611yeyp3/models" }, "resource:by-id": { "href": "/restapis/wn611yeyp3/resources/{resource_id}{?embed}", "templated": true }, "resource:create": { "href": "/restapis/wn611yeyp3/resources/s3dmsjgijc" }, "restapi:authorizers": { "href": "/restapis/wn611yeyp3/authorizers" }, "restapi:delete": { "href": "/restapis/wn611yeyp3" }, "restapi:deployments": { "href": "/restapis/wn611yeyp3/deployments{?limit}", "templated": true }, "restapi:models": { "href": "/restapis/wn611yeyp3/models" }, "restapi:resources": { "href": "/restapis/wn611yeyp3/resources{?limit,embed}", "templated": true }, "restapi:stages": { "href": "/restapis/wn611yeyp3/stages{?deployment_id}", "templated": true }, "restapi:update": { "href": "/restapis/wn611yeyp3" }, "stage:by-name": { "href": "/restapis/wn611yeyp3/stages/{stage_name}", "templated": true }, "stage:create": { "href": "/restapis/wn611yeyp3/stages" } }, "createdDate": "2016-06-06T23:49:37Z", "id": "wn611yeyp3", "name": "my-sample-api" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: