Discourse REST API Dokumentation

[Discourse]

<div data-theme-toc="true"> </div>

# Discourse API

Weitere Informationen finden Sie auf der Discourse API-Dokumentationsseite:

  https://docs.discourse.org

> ## :information_source: Authentifizierung
> **API-Anfragen müssen eine Authentifizierung über HTTP-Header verwenden.** Übergeben Sie Ihren `Api-Key` und `Api-Username` als HTTP-Header. Die Authentifizierung über Abfrageparameter oder den Anforderungskörper wird nicht unterstützt (dies wurde im April 2020 entfernt). Siehe das unten stehende cURL-Beispiel.
>
> Die einzigen API-Endpunkte, die weiterhin Anmeldeinformationen in Abfrageparametern unterstützen, sind Anfragen an RSS-Feeds, den Mail Receiver-Endpunkt und ICS-Routen.
Die Content-Type kann auf „application/x-www-form-urlencoded“, „multipart/form-data“ oder „application/json“ gesetzt werden.

Hier ist ein Beispiel für eine POST-Anfrage über cURL:

```text
curl -X POST "http://127.0.0.1:3000/categories" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: 714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19" \
-H "Api-Username: discourse1" \
-F "name=89853c20-4409-e91a-a8ea-f6cdff96aaaa" \
-F "color=49d9e9" \
-F "text_color=f0fcfd"

---

Hier ist ein Beispiel dafür, wie die API-Dokumentationsseite aussieht:

Die API nutzen

Sie können die API mit cURL-Befehlen verwenden, aber wir empfehlen die Verwendung des Gems discourse_api, damit Sie Ruby verwenden können.

Use the Discourse API ruby gem

So you want to use Discourse API? Great! Let’s get started. Set up Discourse development environment Set up Discourse development environment using our Windows, macOS or Ubuntu guide. Clone Discourse API Gem Now that you have set up Discourse development environment, you should already have Git and Ruby installed on your system. You can install Discourse API gem by running following command from console: git clone https://github.com/discourse/discourse_api.git ~/discourse_api Alternatively…

Reverse Engineering von API-Endpunkten

Nicht jeder Endpunkt ist dokumentiert, aber Sie können ein Beispiel für eine API-Anfrage und -Antwort für jeden Endpunkt finden, indem Sie dieser Anleitung folgen:

Reverse engineer the Discourse API

Discourse is backed by a complete JSON api. Anything you can do on the site you can also do using the JSON api. The API is documented at docs.discourse.org. You can also use the discourse_api Ruby gem as a client library. However, not every endpoint is documented. To determine how to do something with the JSON API here are some steps you can follow. Example: recategorize a topic. Go to a topic and start editing a category: [image] Open Chrome dev tools, switch to the Network tab, select …

Globale Ratenbegrenzungen und Drosselung in Discourse

Discourse wird mit 3 verschiedenen globalen Ratenbegrenzungen ausgeliefert, die von Seitenadministratoren konfiguriert werden können. Weitere Einzelheiten zu diesen Limits finden Sie unter:

Available settings for global rate limits and throttling

Discourse ships with 3 different global rate limits that can be configured by site admins. Global per-ip rate limits These limits apply to every unique IP address that hits the Discourse application. (files that are served directly from the filesystem or the CDN are excluded) By default this rate limit is enabled, you may disable it or set it to a reporting mode. DISCOURSE_MAX_REQS_PER_IP_MODE : default block, this rate limit applies out of the box. (other options are warn, warn+block, and no…

Erstellen von Benachrichtigungen über die API

Creating notifications via the API

Hi, a quick question: Can you send notifications to users with the API? (or another way). In the documentation, I found how to GET notifications of the user, how to mark them as read, but not how to POST some. If it isn’t possible, I guess there is always to possibility of using private messages instead. I would appreciate any input on this. Thanks.

Spezifikation der Benutzer-API-Schlüssel

User API keys specification

Discourse contains a system for generating API keys per user if a very specific protocol is followed. This feature facilitates “application” access to Discourse instances without needing to involve moderators. High level description At a high level: Client (desktop app, browser plugin, mobile app) generates a private/public key pair and return url Client redirects to a route on discourse giving discourse its public key Discourse gets approval from user to use app Discourse generat…

---

Zuletzt überprüft von @sam am 2026-03-17T17:00:00Z