# Stalwart HTTP overview API

**Canonical:** https://apis.io/apis/stalwart/http-api/  
**Provider:** Stalwart — https://apis.io/providers/stalwart/  
**Base URL:** https://get.stalw.art  
**Documentation:** https://stalw.art/docs/http

Stalwart HTTP overview API is one of 3 APIs that [Stalwart](https://apis.io/providers/stalwart/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Stalwart HTTP overview API as documented publicly: 19 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| GET | `/.well-known/jmap` | GET /.well-known/jmap |
| GET | `/api/account` | Returns the authenticated account’s permissions, the server edition and the preferred locale. |
| POST | `/api/auth` | Authenticates a user, and completes an OAuth authorisation request or a device authorisation with the result. |
| GET | `/api/auth/client` | Returns the details of the client that started a sign‑in. |
| POST | `/api/calendar/rsvp` | Reads or answers a calendar invitation through an RSVP link. |
| GET | `/api/discover/{email}` | Returns the OpenID Connect discovery document for the account email. |
| GET | `/api/live/delivery/{target}` | Tests delivery to a domain or address, and streams each step as Server‑Sent Events. |
| GET | `/api/live/metrics` | Streams the current values of the server metrics at a fixed interval, as Server‑Sent Events. |
| GET | `/api/live/tracing` | Streams server events as they occur, as Server‑Sent Events. |
| GET | `/api/schema` | Redirects (302) to /api/schema/{hash}, where {hash} is the SHA‑256 digest of the configuration schema of the running server. |
| GET | `/api/schema/{hash}` | Returns the JSON Schema of the server configuration |
| GET | `/api/token/{kind}` | Issues a short‑lived token for one /api/live/* stream. |
| GET | `/calendar/rsvp` | The RSVP page for calendar invitations, while HTTP RSVP is enabled |
| POST | `/form` | Contact form submission |
| GET | `/healthz/live` | Returns 200 while the process is running |
| GET | `/healthz/ready` | Returns 200 when the data store is available, otherwise 503 |
| GET | `/logo` | The branding logo, while an Enterprise license is active |
| GET | `/metrics/prometheus` | Prometheus metrics, when the Prometheus exporter is enabled |
| GET | `/robots.txt` | Disallows all crawling |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/stalwart/openapi/_ae-authored/stalwart-http-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-get-api-auth-client-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-post-api-auth-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-post-api-auth-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-post-api-calendar-rsvp-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-post-api-calendar-rsvp-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/stalwart/json-schema/stalwart-get-api-account-response-schema.json

## Other Stalwart APIs (2)

- [Stalwart Auth overview API](https://apis.io/apis/stalwart/auth-api/)
- [Stalwart core API](https://apis.io/apis/stalwart/core-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/stalwart/http-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/stalwart/.