REST API ​

Hestia REST API доступен для выполнения основных функций панели управления. Например, мы используем его для внутренней синхронизации кластеров DNS и интеграции биллинговой системы WHMCS. API также можно использовать для создания новых учетных записей пользователей, доменов, баз данных или даже для создания альтернативного веб-интерфейса.

Справочник API предоставляет примеры кода PHP, демонстрирующие, как можно интегрировать API в приложение или скрипт. Однако вы также можете использовать любой другой язык для взаимодействия с API.

С выпуском Hestia v1.6.0 мы представили более продвинутую систему API, которая позволит пользователям, не являющимся администраторами, использовать определенные команды.

Я не могу подключиться к API ​

С выпуском Hestia v1.4.0 мы решили усилить безопасность. Если вы хотите подключиться к API с удаленного сервера, вам сначала нужно будет добавить его IP-адрес в белый список. Чтобы добавить несколько адресов, разделите их новой строкой.

Можно ли отключить API? ​

Да, вы можете отключить API через настройки сервера. Файл будет удален с сервера, а все соединения будут игнорироваться. Обратите внимание, что некоторые функции могут не работать при отключенном API.

Пароль, ключ API или ключи доступа ​

Пароль ​

• Должен использоваться только администратором.
• Изменение пароля администратора требует его обновления везде, где он используется.
• Разрешено запускать все команды.

Ключ API ​

• Должен использоваться только администратором.
• Изменение пароля администратора не имеет последствий.
• Разрешено запускать все команды.

Ключи доступа ​

• Зависит от пользователя.
• Может ограничивать разрешения. Например, только v-purge-nginx-cache.
• Возможность отключить вход другими методами, но при этом разрешить использование ключей API
• Может быть ограничено только администратором или разрешено всем пользователям.

Настройка аутентификации по ключу доступа/секретному ключу ​

Чтобы создать ключ доступа, следуйте руководству в нашей документации.

Если используемое вами программное обеспечение уже поддерживает формат хэша, используйте ACCESS_KEY:SECRET_KEY вместо старого ключа API.

Создание ключа API ​

Запустите команду v-generate-api-key.

Коды возврата ​