Relay proxy endpoints

The most updated documentation about the relay proxy endpoints is the Swagger docs (see Swagger section to see how to access to the documentation).

Swagger

Swagger endpoint is serving a swagger UI to test your REST endpoints. By default, this endpoint is not exposed, you need to have this configuration in your relay proxy configuration file:

# ...

enableSwagger: true
host: my-proxy-domain.com # the DNS to access the proxy

When enabled, you can go to the /swagger/ endpoint with your browser, and you will have access to the Swagger UI for the relay proxy.

OpenAPI documentation

If you don't want to install the relay proxy to check the endpoints, you can go to this OpenAPI documentation directly.