Перейти к содержанию

Хостинг /v2/

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

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

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

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

  • id: int – ID сайта

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

  • offset: int – Индекс первой строки выборки, начиная с 0
  • limit: int – Количество элементов в выборке в диапазоне от 1 до 100
  • order: Sequence[str] – Сортировка элементов в выборке
  • filter: str – Фильтр для запроса

Коды ответов

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

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

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

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

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

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

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

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

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

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

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

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

Коды ответов

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

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

CRON-задание

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

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

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

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

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

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

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

  • id: int – ID Cron-задания

Коды ответов

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

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

CRON-задание

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

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

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

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

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

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

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

  • id: int – ID Cron-задания

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

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

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

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

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

Коды ответов

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

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

CRON-задание

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

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

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

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

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

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

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

  • id: int – ID Cron-задания

Коды ответов

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

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

CRON-задание

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

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

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