Skip to main content

Endpoints

Every Cordice deployment publishes its own addresses. Rather than hard-coding them, ask the API root for a discovery document and read the rest from there — that is how the official clients find everything, and it is what lets a self-hosted instance work without a patched client.

GET https://app.rhmt.online/api/

The response describes the instance: its version, which features are enabled, and the URL of every service that is.

The reference instance

ServiceURLWhat it is
APIhttps://app.rhmt.online/apiREST endpoints
Eventswss://app.rhmt.online/wsThe WebSocket protocol
Fileshttps://app.rhmt.online/autumnUploads and attachments
Embedshttps://app.rhmt.online/januaryLink previews

This instance runs the same code as the repository and is where the clients point today. Treat the addresses as belonging to that instance rather than to Cordice as a project: read them from the discovery document and your client will keep working when they change.

Self-hosted instances

An instance is identified by its API root. Anything else — the events URL, the file service, the size limits, whether registration is open — comes from the discovery document, so a client that reads it needs no configuration beyond a single address.