v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472221377.0 KB

get/v2/apis/{apiId}/exports/{specification}#outputType

Path parameters

apiIdstring required

The API identifier.

specificationstring required

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Query parameters

exportVersionstring

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

includeExtensionsboolean

Specifies whether to include <a href="https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.

outputTypestring required

The output type of the exported definition file. Valid values are JSON and YAML.

stageNamestring

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Response

Success

bodystring

Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.