prose-pod-api

Prose Pod API server. REST API used for administration and management.

Copyright 2022-2025, Prose Foundation - Released under the Mozilla Public License 2.0.

Tested at Rust version: rustc 1.89.0 (29483883e 2025-08-04)

Quick Start

Run the API server

The API can be ran with the following command:

task local:run -- --scenario=demo --ephemeral --api=edge

This will run the latest API version, with the demo scenario, in ephemeral mode. This means that no data will be persisted. Every time you restart the API, you will start from the same fresh demo data again.

The API will be running at localhost:8080.

Read the API documentation

To start the API documentation server, run the following command:

task openapi:preview-docs

Then, open the documentation at localhost:8081.

Access the fake email inbox

Whenever your API is running, a fake email inbox is also running on the side (for development purposes only). This can be used to test email-related functionality without sending actual emails. For instance, you can use this to test user invitations, receive the invitation email, and accept those invitations with the invitation link.

The fake email inbox Web UI is available at localhost:8025.

License

Licensing information can be found in the LICENSE.md document.

🔥 Report A Vulnerability

If you find a vulnerability in any Prose system, you are more than welcome to report it directly to Prose Security by sending an encrypted email to [email protected]. Do not report vulnerabilities in public GitHub issues, as they may be exploited by malicious people to target production systems running an unpatched version.

⚠️ You must encrypt your email using Prose Security GPG public key: 🔑57A5B260.pub.asc.