This page contains the documentation on how to use Discourse through API calls. > Note: For any endpoints not listed you can follow the [reverse engineer the Discourse API](https://meta.discourse.org/t/-/20576) guide to figure out how to use an API endpoint. ### Request Content-Type The Content-T
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://discourse.local https://{defaultHost}
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
This page contains the documentation on how to use Discourse through API calls. > Note: For any endpoints not listed you can follow the [reverse engineer the Discourse API](https://meta.discourse.org/t/-/20576) guide to figure out how to use an API endpoint. ### Request Content-Type The Content-Type for POST and PUT requests can be set to `application/x-www-form-urlencoded`, `multipart/form-dat
| method | path | what the vendor says it does |
|---|---|---|
GET | /admin/backups.json | List backups Backups |
POST | /admin/backups.json | Create backup Backups |
GET | /admin/backups/{filename} | Download backup Backups |
PUT | /admin/backups/{filename} | Send download backup email Backups |
GET | /admin/badges.json | List badges Badges |
POST | /admin/badges.json | Create badge Badges |
PUT | /admin/badges/{id}.json | Update badge Badges |
DELETE | /admin/badges/{id}.json | Delete badge Badges |
POST | /admin/groups.json | Create a group Groups |
DELETE | /admin/groups/{id}.json | Delete a group Groups |
GET | /admin/users/list/{flag}.json | Get a list of users Users Admin |
GET | /admin/users/{id}.json | Get a user by id Users Admin |
DELETE | /admin/users/{id}.json | Delete a user Users Admin |
PUT | /admin/users/{id}/anonymize.json | Anonymize a user Users Admin |
POST | /admin/users/{id}/log_out.json | Log a user out Users Admin |
PUT | /admin/users/{id}/silence.json | Silence a user Users Admin |
PUT | /admin/users/{id}/suspend.json | Suspend a user Users Admin |
GET | /c/{id}/show.json | Show category Categories |
GET | /c/{slug}/{id}.json | List topics Categories |
GET | /categories.json | Retrieves a list of categories Categories |
POST | /categories.json | Creates a category Categories |
PUT | /categories/{id}.json | Updates a category Categories |
GET | /directory_items.json | Get a public list of users Users |
GET | /groups.json | List groups Groups |
GET | /groups/{id}.json | Get a group Groups |
PUT | /groups/{id}.json | Update a group Groups |
GET | /groups/{id}/members.json | List group members Groups |
PUT | /groups/{id}/members.json | Add group members Groups |
DELETE | /groups/{id}/members.json | Remove group members Groups |
POST | /invites.json | Create an invite Invites |
GET | /latest.json | Get the latest topics Topics |
GET | /notifications.json | Get the notifications that belong to the current user Notifications |
PUT | /notifications/mark-read.json | Mark notifications as read Notifications |
POST | /post_actions.json | Like a post and other actions Posts |
GET | /posts.json | List latest posts across topics Posts |
POST | /posts.json | Creates a new topic, a new post, or a private message Posts Topics Private Messages |
GET | /posts/{id}.json | Retrieve a single post Posts |
PUT | /posts/{id}.json | Update a single post Posts |
DELETE | /posts/{id}.json | delete a single post Posts |
PUT | /posts/{id}/locked.json | Lock a post from being edited Posts |
and 44 more operation(s) in this specification, all searchable.
specification origin: http://docs.discourse.org/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.