Swagger UI

Applies toSelf-Managed v3

1 min read

On this page

Disable the Swagger UI
What Stays Available

Ververica Platform serves an interactive Swagger UI for exploring the REST API, enabled by default and available at /swagger. Starting with Ververica Platform 3.1.3, you can turn it off on a self-managed installation while keeping the REST API itself available.

Note

This setting is available for self-managed Ververica Platform 3 only, starting with version 3.1.3. It doesn't apply to Ververica Cloud.

Disable the Swagger UI

Set api-gateway.swagger.ui.enabled to false in your Helm values, then upgrade the chart:

YAML

1api-gateway:
2  swagger:
3    ui:
4      enabled: false

Or set it directly on the command line:

BASH

1helm upgrade <release-name> <chart> -f <your-values-file>.yaml \
2  --set api-gateway.swagger.ui.enabled=false

The api-gateway pod restarts automatically when you run helm upgrade, so no manual restart is needed.

What Stays Available

Disabling the Swagger UI removes the interactive interface only. With it off, /swagger and /swagger-ui/ return 404, but the REST API and its OpenAPI specification endpoint are unchanged and continue to respond normally.

Note

Ververica Platform requires a signed-in user to reach the Swagger UI whether this setting is on or off. Disabling it removes the interface entirely, rather than being the only protection against unauthenticated access.

Was this helpful?

Yes No