Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Publish API documentation using the API Gateway console

Focus mode
Publish API documentation using the API Gateway console - Amazon API Gateway
This page has not been translated into your language. Request translation

The following procedure describes how to publish a documentation version.

To publish a documentation version using the API Gateway console
  1. In the main navigation pane, choose Documentation.

  2. Choose Publish documentation.

  3. Set up the publication:

    1. For Stage, select a stage.

    2. For Version, enter a version identifier, e.g., 1.0.0.

    3. (Optional) For Description, enter a description.

  4. Choose Publish.

You can now proceed to download the published documentation by exporting the documentation to an external OpenAPI file. To learn more, see Export a REST API from API Gateway.

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.