diff options
Diffstat (limited to 'docs/development/API')
| -rw-r--r-- | docs/development/API/admin_api.md | 47 | 
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index 7d31ee262..b8dc419e2 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -1751,3 +1751,50 @@ Note that this differs from the Mastodon API variant: Mastodon API only returns  ```json  {}  ``` + + +## `GET /api/v1/pleroma/admin/rules` + +### List rules + +- Response: JSON, list of rules + +```json +[ +  { +    "id": "1", +    "priority": 1, +    "text": "There are no rules" +  } +] +``` + +## `POST /api/v1/pleroma/admin/rules` + +### Create a rule + +- Params: +  - `text`: string, required, rule content +  - `priority`: integer, optional, rule ordering priority + +- Response: JSON, a single rule + +## `PATCH /api/v1/pleroma/admin/rules/:id` + +### Update a rule + +- Params: +  - `text`: string, optional, rule content +  - `priority`: integer, optional, rule ordering priority + +- Response: JSON, a single rule + +## `DELETE /api/v1/pleroma/admin/rules/:id` + +### Delete a rule + +- Response: JSON, empty object + +```json +{} +```  | 
