Access the interactive documentation (Rendered access)

Platform gateway provides an interactive, rendered version of the OpenAPI specification accessible directly in a web browser.

Procedure

  1. Go to the documentation endpoint by using the following URL structure, replacing $AAP_INSTANCE with your hostname:
    https://$AAP_INSTANCE/api/gateway/v1/docs/
  2. Explore the available API endpoints, view required parameters, and test interactions with the resources exposed by platform gateway.