beget.yml

name: "Cloud"
caption: "Управляемые сервисы"
title: "API Управляемых сервисов"
index: 'API управляемых сервисов предлагает вам методы создания управляемых сервисов на платформе Beget (например, MySQL), получения статуса управляемых сервисов, выполнения различных операций с ними или их удаления. API управляемых сервисов <b>пригодится вам для создания и управления ими через свои скрипты и приложения</b>.
<br/><br/>
В каждом запросе необходимо передавать JWT-токен, который вы можете получить с помощью <b><a href="/#post-/v1/auth" target="_blank">API аутентификации</a></b>.
<br/><br/>
<details>
<summary><b>Коды ответа</b></summary>
<br/>
<div>
Для <b>200</b> кода ответа вы всегда можете ожидать тело ответа, задокументированное на справочной странице API.
<br/><br/>
<b>400 (неверный запрос)</b> Эта ошибка указывает на синтаксическую ошибку в запросе. Клиент не должен продолжать делать подобные запросы без изменения синтаксиса или выполняемых запросов.
<br/><br/>
<b>401 (неверный JWT токен)</b> Эта ошибка указывает на то, что сделанный запрос не содержал необходимых учетных данных для проверки подлинности (например, JWT токен), и поэтому клиенту было отказано в доступе. Клиент не должен продолжать делать подобные запросы без включения JWT токена в запрос.
<br/><br/>
<b>404 (не найдено)</b> Эта ошибка указывает на то, что сервер не нашел ресурса для выполняемого запроса API.
<br/><br/>
<b>500 (внутренняя ошибка сервера)</b> Эта ошибка указывает на непредвиденное условие или исключение, которое помешало серверу выполнить запрос API.
</div>
</details>
<br/><br/>
<details>
<summary><b>Фильтрация и сортировка</b></summary>
<br/>
<div>
Если метод API поддерживает параметры <code>filter</code> или <code>sort</code>, вы можете использовать их для фильтрации и сортировки списка возвращаемых ресурсов.
<br/><br/>
<h3>Фильтрация</h3>
Выражение состоит из одного или нескольких условий, объединенных логическими операторами <code>AND</code> и <code>OR</code>: <code>&lt;условие1&gt; [AND &lt;условие2&gt; [&lt;...&gt; OR &lt;условиеN&gt;]]</code>
<br/><br/>
Каждое условие имеет вид <code>&lt;поле&gt; &lt;оператор&gt; &lt;значение&gt;</code>, где:
<ol>
<li><code>&lt;поле&gt;</code> — имя поля.</li>
<li><code>&lt;оператор&gt;</code> — логический оператор, один из <code>=</code> (строгое сравнение), <code>:</code> (вхождение подстроки).</li>
<li><code>&lt;значение&gt;</code> — значение для сравнения.</li>
</ol>
Строковые значения должны быть заключены в двойные кавычки (<code>"</code>).
Поддерживаются escape-последовательности в стиле C (<code>\"</code> преобразуется в <code>"</code>, <code>\\</code> в обратную косую черту).
<br/><br/>
Для группировки условий используются круглые скобки <code>()</code>. Поддерживается не более двух уровней вложенности скобок.
<br/>
<h3>Сортировка</h3>
Определяет поле и направление сортировки в формате <code>&lt;поле&gt; &lt;направление&gt;</code>
<br/><br/>
<b>Направление сортировки:</b>
<ul>
<li><code>asc</code> — по возрастанию (по умолчанию)</li>
<li><code>desc</code> — по убыванию</li>
</ul>
Если параметр не указан, используется сортировка по умолчанию: <code>id asc</code>
</div>
</details>'