GET

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

http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/exports/{specification}#outputType

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

specificationstringrequired

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

Query Params

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.

outputTypestringrequired

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/exports/{specification}#outputType' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET