-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbeget.yml
22 lines (22 loc) · 2.54 KB
/
beget.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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>'