/v2/apis/{apiId}/exports/{specification}

Request

Path Params

apiId

string

required

The API identifier.

specification

string

required

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

Query Params

exportVersion

string

optional

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

includeExtensions

string

optional

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

outputType

string

required

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

stageName

string

optional

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

Responses

🟢200Success

application/json

Body

body

string

optional

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.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException