ExportedAPI
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.
URI
/v2/apis/apiId/exports/specification
HTTP methods
GET
Operation ID: ExportApi
Exports a definition of an API in a particular output format and specification.
| Name | Type | Required | Description |
|---|---|---|---|
specification | String | True | The version of the API specification to use. |
apiId | String | True | The API identifier. |
| Name | Type | Required | Description |
|---|---|---|---|
includeExtensions | String | False | Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default. |
stageName | String | False | The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported. |
exportVersion | String | False | The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is |
outputType | String | True | The output type of the exported definition file. Valid values are |
| Status code | Response model | Description |
|---|---|---|
200 | ExportedApi | Success |
400 | BadRequestException | One of the parameters in the request is invalid. |
404 | NotFoundException | The resource specified in the request was not found. |
429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. |
Schemas
Response bodies
"string"
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
Properties
BadRequestException
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | Describes the error encountered. |
LimitExceededException
A limit has been exceeded. See the accompanying error message for details.
| Property | Type | Required | Description |
|---|---|---|---|
limitType | string | False | The limit type. |
message | string | False | Describes the error encountered. |
NotFoundException
The resource specified in the request was not found. See the message field for more information.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | Describes the error encountered. |
resourceType | string | False | The resource type. |