Doku:API-Schlüssel

Anbinden

API-Schlüssel

API-Schlüssel für die Mailiy-API anlegen, auf Websites begrenzen oder nur lesend vergeben.

Dashboard-Ausschnitt: API-Schlüssel
Im Dashboard unter API-Schlüssel

Unter Konto → API-Schlüssel legst du Schlüssel für die API, das SDK und den MCP-Server an. Ein Schlüssel darf entweder lesen und schreiben oder nur lesen. Du kannst ihn außerdem auf eine oder mehrere Websites beschränken: Dann sieht er nur deren Formulare und Einsendungen. Löschst du die letzte dieser Websites, wird auch der Schlüssel gelöscht. Dein Konto selbst (Profil, Empfängeradressen, Tarif) lässt sich mit keinem Schlüssel ändern.

Jeder Schlüssel darf 120 Anfragen pro Minute schicken. Die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset zeigen den Stand, darüber antwortet die API mit 429 und Retry-After. Einsendungen liest du seitenweise mit limit (bis 500) und cursor; den Wert für die nächste Seite liefert der Header X-Next-Cursor. Alle Routen stehen in der OpenAPI-Beschreibung.