Хостинг

Настройка почтового ящика для уведомлений
Получение списка заданий
Добавление нового задания
Информация о задании
Редактирование существующего задания
Удаление задания

Настройка почтового ящика для уведомлений

URL: /api/v1/hosting/virtualhosts/{id}/set-cron-mail/
Метод: PUT
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - ID сайта

Параметры тела запроса

Обязательные параметры:

cron_mail: str - Почтовый адрес для отправки сообщений из cron

Коды ответов

Код	Описание
200	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Сайт

id: int - Идентификатор сайта
name: str - Имя сайта
state: int - Статус:
- ENABLED - активен
- DISABLED_BY_USER - Отключен пользователем
- DISABLED_BY_SERVICE - Отключен за неуплату
- DISABLED_BY_ADMIN - Отключен администратором
- DISABLED_BY_QUOTA - Отключен за превышение квоты
created: datetime - Дата создания
updated: datetime - Дата изменения
force_https: bool - Автоматическое перенаправление на использование протокола HTTPS. (Только при наличии SSL-сертификата)
certificate_id: int - Идентификатор SSL-сертификата
main_alias: str - Главный адрес сайта. На него будут автоматически перенаправляться запросы с других адресов
aliases: Список str - Список адресов сайта
engine: str - Технология на которой работает сайт:
- php - PHP
- python - Python
- ruby - Ruby
- node - Node.js
- exec - Python AsyncIO
engine_version: str - Версия технологии
engine_directives: Список str - Список дополнительных параметров
charset: str - Кодировка сайта:
- utf-8 - UTF-8
- windows-1251 - Windows-1251
cron_mail: str - Почтовый адрес для отправки сообщений из cron
container_id: int - Идентификатор контейнера в котором размещается сайт
environment_variables: Список str - Переменные окружения
read_only_environment_variables: Список str - Readonly переменные окружения
num_workers: int - Количество воркеров от 1 до 24
cache_static: int - Срок хранения статики в сутках (кроме сайтов на PHP)
app_state: str - Состояние приложения
comment: str - Комментарий

Пример запроса

curl --request PUT 'https://api-ms.netangels.ru/api/v1/hosting/virtualhosts/{id}/set-cron-mail/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "cron_mail": "admin@example.com" 
    }'

Получение списка заданий

URL: /api/v1/hosting/virtualhosts/{id}/crontabs/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - ID сайта

Необязательные параметры:

offset: int - Индекс первой строки выборки, начиная с 0
limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

count: int - Количество элементов
entities - Список cron-заданий
- id: int - Идентификатор задания
- command: str - Команда CRON-задания
- comment: str - Комментарий к заданию
- created: datetime - Дата создания задания
- updated: datetime - Дата изменения задания
- virtual_host: tuple - Полная информация о сайте и контейнере, в котором он содержится
- virtualhost_id: int - ID сайта, к которому относится задание
- days: str - Дни
- hours: str - Часы
- minutes: str - Минуты
- months: str - Месяцы
- weekdays: str - Дни недели

Пример запроса

curl --request GET 'https://api-ms.netangels.ru/api/v1/hosting/virtualhosts/{id}/crontabs/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Добавление нового задания

URL: /api/v1/hosting/crontabs/
Метод: POST
Результат: JSON

Параметры тела запроса

Обязательные параметры:

virtualhost_id: int - ID сайта
minutes: str - Минуты
hours: str - Часы
days: str - Дни
months: str - Месяцы
weekdays: str - Дни недели
command: str - Команда

Необязательные параметры:

comment: str - Комментарий

Коды ответов

Код	Описание
200	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Сайт

id: int - Идентификатор сайта
name: str - Имя сайта
state: int - Статус:
- ENABLED - активен
- DISABLED_BY_USER - Отключен пользователем
- DISABLED_BY_SERVICE - Отключен за неуплату
- DISABLED_BY_ADMIN - Отключен администратором
- DISABLED_BY_QUOTA - Отключен за превышение квоты
created: datetime - Дата создания
updated: datetime - Дата изменения
force_https: bool - Автоматическое перенаправление на использование протокола HTTPS. (Только при наличии SSL-сертификата)
certificate_id: int - Идентификатор SSL-сертификата
main_alias: str - Главный адрес сайта. На него будут автоматически перенаправляться запросы с других адресов
aliases: Список str - Список адресов сайта
engine: str - Технология на которой работает сайт:
- php - PHP
- python - Python
- ruby - Ruby
- node - Node.js
- exec - Python AsyncIO
engine_version: str - Версия технологии
engine_directives: Список str - Список дополнительных параметров
charset: str - Кодировка сайта:
- utf-8 - UTF-8
- windows-1251 - Windows-1251
cron_mail: str - Почтовый адрес для отправки сообщений из cron
container_id: int - Идентификатор контейнера в котором размещается сайт
environment_variables: Список str - Переменные окружения
read_only_environment_variables: Список str - Readonly переменные окружения
num_workers: int - Количество воркеров от 1 до 24
cache_static: int - Срок хранения статики в сутках (кроме сайтов на PHP)
app_state: str - Состояние приложения
comment: str - Комментарий

Пример запроса

curl --request POST 'https://api-ms.netangels.ru/api/v1/hosting/crontabs/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "virtualhost_id": 1001, 
          "minutes": "12", 
          "hours": "10", 
          "days": "6", 
          "months": "5", 
          "weekdays": "3", 
          "command": "cd www", 
          "comment": "Комментарий" 
    }'

Информация о задании

URL: /api/v1/hosting/crontabs/{id}/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор CRON-задания

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

CRON-задание

id: int - Идентификатор задания
command: str - Команда CRON-задания
comment: str - Комментарий к заданию
created: datetime - Дата создания задания
updated: datetime - Дата изменения задания
virtual_host: tuple - Полная информация о сайте и контейнере, в котором он содержится
virtualhost_id: int - ID сайта, к которому относится задание
days: str - Дни
hours: str - Часы
minutes: str - Минуты
months: str - Месяцы
weekdays: str - Дни недели

Пример запроса

curl --request GET 'https://api-ms.netangels.ru/api/v1/hosting/crontabs/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Редактирование существующего задания

URL: /api/v1/hosting/crontabs/{id}/
Метод: PUT
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор CRON-задания

Параметры тела запроса

Необязательные параметры:

minutes: str - Минуты
hours: str - Часы
days: str - Дни
months: str - Месяцы
weekdays: str - Дни недели
command: str - Команда
comment: str - Комментарий

Коды ответов

Код	Описание
200	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Сайт

id: int - Идентификатор сайта
name: str - Имя сайта
state: int - Статус:
- ENABLED - активен
- DISABLED_BY_USER - Отключен пользователем
- DISABLED_BY_SERVICE - Отключен за неуплату
- DISABLED_BY_ADMIN - Отключен администратором
- DISABLED_BY_QUOTA - Отключен за превышение квоты
created: datetime - Дата создания
updated: datetime - Дата изменения
force_https: bool - Автоматическое перенаправление на использование протокола HTTPS. (Только при наличии SSL-сертификата)
certificate_id: int - Идентификатор SSL-сертификата
main_alias: str - Главный адрес сайта. На него будут автоматически перенаправляться запросы с других адресов
aliases: Список str - Список адресов сайта
engine: str - Технология на которой работает сайт:
- php - PHP
- python - Python
- ruby - Ruby
- node - Node.js
- exec - Python AsyncIO
engine_version: str - Версия технологии
engine_directives: Список str - Список дополнительных параметров
charset: str - Кодировка сайта:
- utf-8 - UTF-8
- windows-1251 - Windows-1251
cron_mail: str - Почтовый адрес для отправки сообщений из cron
container_id: int - Идентификатор контейнера в котором размещается сайт
environment_variables: Список str - Переменные окружения
read_only_environment_variables: Список str - Readonly переменные окружения
num_workers: int - Количество воркеров от 1 до 24
cache_static: int - Срок хранения статики в сутках (кроме сайтов на PHP)
app_state: str - Состояние приложения
comment: str - Комментарий

Пример запроса

curl --request PUT 'https://api-ms.netangels.ru/api/v1/hosting/crontabs/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "minutes": "12", 
          "hours": "10", 
          "days": "6", 
          "months": "5", 
          "weekdays": "3", 
          "command": "cd www", 
          "comment": "Комментарий" 
    }'

Удаление задания

URL: /api/v1/hosting/crontabs/{id}/
Метод: DELETE
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор CRON-задания

Коды ответов

Код	Описание
200	Успешный запрос

Пример запроса

curl --request DELETE 'https://api-ms.netangels.ru/api/v1/hosting/crontabs/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search