Stump's REST API

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

Authentication

Sessions

Stump uses server-side sessions to authenticate users. These sessions are stored in the database, and are automatically cleaned up within 60 seconds of expiring. You can change the expiry cleanup check interval by setting the SESSION_EXPIRY_CLEANUP_INTERVAL environment variable. See the configuration guide for more information.

Basic Authentication

Stump supports Basic Authentication (opens in a new tab) in order to properly support OPDS clients. Authenticating using this method will still create a server-side session for you.

Swagger UI

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 (opens in a new tab). Under the hood, Stump uses utoipa (opens in a new tab) 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 (opens in a new tab) outlining the problem.

Disabling Swagger UI

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.