> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Каталог методов

> 73 доступных метода API Guard Forum: стандартные ресурсы XenForo и дополнения Guard.

Выберите ресурс и откройте описание нужной операции. В каталоге указаны 69 доступных стандартных методов XenForo 2.2.19 и 4 метода дополнений Guard Forum.

Все пути ниже указаны относительно `https://forum.arzguard.com/api/`. Ключ обязателен в каждом запросе. Scopes и права контекста описаны у конкретного метода.

> [!NOTE]
>
> Примеры запросов на страницах методов предназначены для вашей серверной интеграции. Операции POST и DELETE могут изменять данные, отправлять уведомления или запускать связанные действия; перед выполнением учитывайте описание метода.

## Форумы

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`forums/{id}/`](/guard-forum/api/get-forums-id) | Получить раздел |
| `POST` | [`forums/{id}/mark-read`](/guard-forum/api/post-forums-id-mark-read) | Отметить раздел прочитанным |
| `GET` | [`forums/{id}/threads`](/guard-forum/api/get-forums-id-threads) | Темы раздела |

## Поисковые разделы

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`search-forums/{id}/`](/guard-forum/api/get-search-forums-id) | Получить поисковый раздел |
| `GET` | [`search-forums/{id}/threads`](/guard-forum/api/get-search-forums-id-threads) | Темы поискового раздела |

## Темы

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`threads/`](/guard-forum/api/get-threads) | Список тем |
| `POST` | [`threads/`](/guard-forum/api/post-threads) | Создать тему |
| `GET` | [`threads/{id}/`](/guard-forum/api/get-threads-id) | Получить тему |
| `POST` | [`threads/{id}/`](/guard-forum/api/post-threads-id) | Изменить тему |
| `DELETE` | [`threads/{id}/`](/guard-forum/api/delete-threads-id) | Удалить тему |
| `POST` | [`threads/{id}/change-type`](/guard-forum/api/post-threads-id-change-type) | Изменить тип темы |
| `POST` | [`threads/{id}/mark-read`](/guard-forum/api/post-threads-id-mark-read) | Отметить тему прочитанной |
| `POST` | [`threads/{id}/move`](/guard-forum/api/post-threads-id-move) | Переместить тему |
| `GET` | [`threads/{id}/posts`](/guard-forum/api/get-threads-id-posts) | Сообщения темы |
| `POST` | [`threads/{id}/vote`](/guard-forum/api/post-threads-id-vote) | Голос за тему |

## Сообщения

| Метод | Путь | Назначение |
| - | - | - |
| `POST` | [`posts/`](/guard-forum/api/post-posts) | Ответить в теме |
| `GET` | [`posts/{id}/`](/guard-forum/api/get-posts-id) | Получить сообщение |
| `POST` | [`posts/{id}/`](/guard-forum/api/post-posts-id) | Изменить сообщение |
| `DELETE` | [`posts/{id}/`](/guard-forum/api/delete-posts-id) | Удалить сообщение |
| `POST` | [`posts/{id}/mark-solution`](/guard-forum/api/post-posts-id-mark-solution) | Переключить отметку решения |
| `POST` | [`posts/{id}/react`](/guard-forum/api/post-posts-id-react) | Реакция на сообщение |
| `POST` | [`posts/{id}/vote`](/guard-forum/api/post-posts-id-vote) | Голос за сообщение |

## Профиль пользователя

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`users/{id}/`](/guard-forum/api/get-users-id) | Получить пользователя по ID |

## Текущий пользователь

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`me/`](/guard-forum/api/get-me) | Получить текущего пользователя |
| `POST` | [`me/`](/guard-forum/api/post-me) | Изменить свой профиль |
| `POST` | [`me/avatar`](/guard-forum/api/post-me-avatar) | Загрузить свой аватар |
| `DELETE` | [`me/avatar`](/guard-forum/api/delete-me-avatar) | Удалить свой аватар |
| `POST` | [`me/email`](/guard-forum/api/post-me-email) | Изменить свой email |
| `POST` | [`me/password`](/guard-forum/api/post-me-password) | Изменить свой пароль |

## Записи профиля

| Метод | Путь | Назначение |
| - | - | - |
| `POST` | [`profile-post-comments/`](/guard-forum/api/post-profile-post-comments) | Добавить комментарий профиля |
| `GET` | [`profile-post-comments/{id}/`](/guard-forum/api/get-profile-post-comments-id) | Получить комментарий профиля |
| `POST` | [`profile-post-comments/{id}/`](/guard-forum/api/post-profile-post-comments-id) | Изменить комментарий профиля |
| `DELETE` | [`profile-post-comments/{id}/`](/guard-forum/api/delete-profile-post-comments-id) | Удалить комментарий профиля |
| `POST` | [`profile-post-comments/{id}/react`](/guard-forum/api/post-profile-post-comments-id-react) | Реакция на комментарий профиля |
| `POST` | [`profile-posts/`](/guard-forum/api/post-profile-posts) | Создать запись в профиле |
| `GET` | [`profile-posts/{id}/`](/guard-forum/api/get-profile-posts-id) | Получить запись профиля |
| `POST` | [`profile-posts/{id}/`](/guard-forum/api/post-profile-posts-id) | Изменить запись профиля |
| `DELETE` | [`profile-posts/{id}/`](/guard-forum/api/delete-profile-posts-id) | Удалить запись профиля |
| `GET` | [`profile-posts/{id}/comments`](/guard-forum/api/get-profile-posts-id-comments) | Комментарии записи профиля |
| `POST` | [`profile-posts/{id}/react`](/guard-forum/api/post-profile-posts-id-react) | Реакция на запись профиля |

## Личные диалоги

| Метод | Путь | Назначение |
| - | - | - |
| `POST` | [`conversation-messages/`](/guard-forum/api/post-conversation-messages) | Ответить в переписке |
| `GET` | [`conversation-messages/{id}/`](/guard-forum/api/get-conversation-messages-id) | Получить сообщение переписки |
| `POST` | [`conversation-messages/{id}/`](/guard-forum/api/post-conversation-messages-id) | Изменить сообщение переписки |
| `POST` | [`conversation-messages/{id}/react`](/guard-forum/api/post-conversation-messages-id-react) | Поставить реакцию на сообщение |
| `GET` | [`conversations/`](/guard-forum/api/get-conversations) | Получить список переписок |
| `POST` | [`conversations/`](/guard-forum/api/post-conversations) | Создать переписку |
| `GET` | [`conversations/{id}/`](/guard-forum/api/get-conversations-id) | Получить переписку |
| `POST` | [`conversations/{id}/`](/guard-forum/api/post-conversations-id) | Изменить переписку |
| `DELETE` | [`conversations/{id}/`](/guard-forum/api/delete-conversations-id) | Убрать переписку из списка |
| `POST` | [`conversations/{id}/invite`](/guard-forum/api/post-conversations-id-invite) | Пригласить в переписку |
| `POST` | [`conversations/{id}/mark-read`](/guard-forum/api/post-conversations-id-mark-read) | Отметить переписку прочитанной |
| `POST` | [`conversations/{id}/mark-unread`](/guard-forum/api/post-conversations-id-mark-unread) | Отметить переписку непрочитанной |
| `GET` | [`conversations/{id}/messages`](/guard-forum/api/get-conversations-id-messages) | Получить сообщения переписки |
| `POST` | [`conversations/{id}/star`](/guard-forum/api/post-conversations-id-star) | Изменить отметку избранного |

## Уведомления

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`alerts/`](/guard-forum/api/get-alerts) | Получить уведомления |
| `POST` | [`alerts/`](/guard-forum/api/post-alerts) | Отправить уведомление |
| `POST` | [`alerts/mark-all`](/guard-forum/api/post-alerts-mark-all) | Отметить все уведомления |
| `GET` | [`alerts/{id}/`](/guard-forum/api/get-alerts-id) | Получить уведомление |
| `POST` | [`alerts/{id}/mark`](/guard-forum/api/post-alerts-id-mark) | Изменить отметку уведомления |

## Вложения

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`attachments/`](/guard-forum/api/get-attachments) | Получить временные вложения |
| `POST` | [`attachments/`](/guard-forum/api/post-attachments) | Загрузить вложение |
| `POST` | [`attachments/new-key`](/guard-forum/api/post-attachments-new-key) | Создать ключ вложений |
| `GET` | [`attachments/{id}/`](/guard-forum/api/get-attachments-id) | Получить данные о вложении |
| `DELETE` | [`attachments/{id}/`](/guard-forum/api/delete-attachments-id) | Удалить вложение |
| `GET` | [`attachments/{id}/data`](/guard-forum/api/get-attachments-id-data) | Скачать вложение |
| `GET` | [`attachments/{id}/thumbnail`](/guard-forum/api/get-attachments-id-thumbnail) | Получить адрес миниатюры |

## Аутентификация

| Метод | Путь | Назначение |
| - | - | - |
| `POST` | [`auth/`](/guard-forum/api/post-auth) | Проверить логин и пароль |
| `POST` | [`auth/from-session`](/guard-forum/api/post-auth-from-session) | Определить пользователя по сессии |
| `POST` | [`auth/login-token`](/guard-forum/api/post-auth-login-token) | Создать ссылку для входа |

## Повышение и снятие

| Метод | Путь | Назначение |
| - | - | - |
| `GET` | [`promote/{user_id}/`](/guard-forum/api/get-promote-user_id) | Повышение: доступные группы |
| `GET` | [`demote/{user_id}/`](/guard-forum/api/get-demote-user_id) | Снятие: доступные группы |
| `POST` | [`promote/{user_id}/`](/guard-forum/api/post-promote-user_id) | Повысить пользователя |
| `POST` | [`demote/{user_id}/`](/guard-forum/api/post-demote-user_id) | Снять группу у пользователя |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.