Stump's REST API

Stump exposes a REST API that allows you to interact with your Stump server.

Stump's REST API is documented using Swagger. You can access Swagger UI by visiting visiting http(s)://your-server(:10801)/swagger-ui. If you aren't familiar with Swagger, you can read more about it here. Under the hood, Stump uses utoipa for semi-automated Swagger generation. If you find any issues or inconsistencies with the API options available while using the Swagger UI, please open an issue outlining the problem.

If you don't want to expose Swagger UI, you can disable it by setting the ENABLE_SWAGGER_UI environment variable to false. See the configuration guide for more information.

Stump uses server-side sessions to authenticate users. For OPDS-specific API endpoints, Basic Authentication is also used.

If you attempt to access an OPDS endpoint with Basic Authentication, a session will also be created for you.