Skip to content
Last updated

The hideReplay configuration option allows you to control the visibility of the Try it buttons associated with API requests.

For example, you might want to hide the Try it button in your public API documentation, and make it visible only on your internal website.

Options

OptionTypeDescription
hideReplaybooleanHide the Replay component that allows users to interactively send requests to an API. Defaults to false.

Examples

The following example hides the Replay component from the API reference documentation.

redocly.yaml
openapi:
  hideReplay: true

Resources

  • OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
  • OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
  • OpenAPI visual reference - Visual guide to OpenAPI specification structure and Replay button customization
  • Configuration options - Explore other project configuration options for comprehensive documentation customization