Schema
Return the configuration schema at a specific hash
Changed onReturns the JSON Schema describing the full Stalwart configuration tree. The response is always gzip-encoded (Content-Encoding: gzip) and served with an immutable cache policy — the schema for a given hash never changes. If the hash does not match the server's current schema, the server redirects to the correct URL.
get/api/schema/{hash}
Request
- Base URLhttps://mail.example.com
- Auth
- HTTP bearer
- or HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
hashstring required
SHA-256 hex digest of the configuration schema
Response
Gzipped JSON Schema document
object required
JSON Schema document describing Stalwart config
Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking