{"swagger":"2.0","info":{"description":"\nAPI для работы с хостингом позволяет автоматизировать управление ресурсами и анализ данных.\n\n## Примеры использования API хостинга:\n\n* Отслеживание состояния аккаунта и своевременный анализ уведомлений\n* Автоматическое создание, удаление, конфигурирование ресурсов\n* Доступ к данным внутреннего мониторинга 1Gb.ru, анализ качества работы VDS\n* Автоматизация типовых реакций на проблемы ресурсов и хостинга \n\nДоступ к API хостинга активен в любом оплаченном тарифном плане. Для тестовых или бесплатных аккаунтов API не работает. \n\n## Принципы работы и примеры\n\nДоступ происходит по протоколу HTTPS по базовому адресу https://www.1gb.ru/api/. Параметры большинства запросов можно передавать с помощью GET или POST параметров. Ответ содержит объект или массив объектов по стандарту JSON.\n\nПеред началом работы с API требуется получить token для дальнейшей авторизации. Это делается следующим образом (приведены примеры использования GET параметров):\n\n1. https://www.1gb.ru/api/auth/start?login=[логин_кабинета] - возвращает в ответ string, содержащий соль\n2. https://www.1gb.ru/api/auth/login?login=[логин_кабинета]&salt=[соль]&response=[response] - возвращает в ответ string, содержащий token; псевдокод для вычисления response на PHP: *md5($password.$salt.\"\\n\")* (сумма md5 строки \"пароль+соль+символ-перевода-строки\")\n\nПоследний запрос возвращает string, в нем token, его нужно запомнить и использовать для последующей авторизации. Token утрачивает силу при смене главного пароля аккаунта, существует также возможность деактивировать отдельные token-ы со страницы кабинета \"смена главного пароля аккаунта\".\n\nПримеры дальнейших запросов:\n\n    https://www.1gb.ru/api/billing/info?_token_=[запомненный token] - получение общих данных аккаунта \n\nОтветы API с HTTP кодом 200 обозначают успешное исполнение операции. В ответном JSON может содержаться два разных типа:\n\n* [ \"string\" ]: либо просто \"OK\", либо \"[число]\" (необходимо привести к int), если возвращается ID созданного объекта\n* [ { ... } , { ... } ] (массив объектов): если запрос возвращает список из 0 или более структур (хеш \"поле\":\"значение\"). \n\nДругие коды (больше 200) обозначают ошибку, при этом тело ответа содержит string с объяснением, пример: \"ERROR: vds.missing\".\n\n## Команды API и общие соглашения\n\nБольшинство команд API, таких как /list, возвращают внутренние структуры из базы данных хостинга, которые содержат сотни полей. Документировать их трудоемко, поэтому рекомендуем просто смотреть на вывод соответствующих команд и анализировать структуры данных по очевидным названиям полей.\n\nВ том случае, если трактовка полей вызывает затруднения, пишите на support@1gb.ru, поможем разобраться.\n\n## Общедоступные на данный момент команды\n\nhttps://www.1gb.ru/api + адрес из списка ниже. Обязательный параметр каждой команды (кроме этапа авторизации) - _token_. Остальные параметры приведены после команды.\n\t","version":"2.0.0","title":"1Gb API"},"host":"www.1gb.ru","basePath":"/api","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/auth/login":{"post":{"tags":["auth / Авторизация, начало работы с API"],"summary":"Получить ключ доступа","description":"Возвращает ключ доступа, с которым в дальнейшем будут осуществляться всё взаимодействие с API\n\t(параметр 'token'). Для вычисления значения параметра 'response' необходимо получить представленную в hex MD5-сумму от\n\tобъединения строк пароля пользователя, полученной соли и символа переноса строки. Псевдокод операции:\n\thex(md5(password&nbsp;+&nbsp;salt&nbsp;+&nbsp;'\\n'))","operationId":"authLoginPOST","parameters":[{"name":"login","in":"query","description":"Имя пользователя","required":true,"type":"string"},{"name":"salt","in":"query","description":"Соль (см. /auth/start)","required":true,"type":"string"},{"name":"response","in":"query","description":"Вычисленный хэш","required":true,"type":"string"}],"responses":{"200":{"description":"Ключ доступа","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"AuthAPI"}},"/auth/start":{"get":{"tags":["auth / Авторизация, начало работы с API"],"summary":"Получить соль","description":"Возвращает соль для авторизации. Это первый этап идентификации пользователя. Затем соль используется\n\tво втором, окончательном этапе авторизации, в запросе /auth/login. Запрос не требует дополнительных параметров.","operationId":"authStartGET","parameters":[{"name":"login","in":"query","description":"Имя пользователя","required":true,"type":"string"}],"responses":{"200":{"description":"Соль для авторизации","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"AuthAPI"}},"/balance":{"get":{"tags":["Аккаунт - биллинг, свойства и статус"],"summary":"Аккаунт: баланс","description":"Возвращает текущий баланс аккаунта","operationId":"balanceGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Текущий баланс аккаунта хостинга","schema":{"type":"number"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/balance.lic":{"get":{"tags":["Аккаунт - биллинг, свойства и статус"],"summary":"Аккаунт: баланс аккаунта лицензий","description":"Возвращает текущий баланс аккаунта лицензий","operationId":"balance_licGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Текущий баланс аккаунта лицензий","schema":{"type":"number"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/billing/debt":{"get":{"tags":["Аккаунт - биллинг, свойства и статус"],"summary":"Информация по дебету аккаунта","description":"Данный запрос позволяет получить информацию по планируемым датам наступления негативного баланса и отключения","operationId":"billingDebtGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Информация по дебету аккаунта","schema":{"type":"array","title":"Информация по дебету аккаунта","items":{"$ref":"#/definitions/inline_response_200"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/billing/info":{"get":{"tags":["Аккаунт - биллинг, свойства и статус"],"summary":"Информация об аккаунте","description":"Этот запрос позволяет получить информацию об аккаунте, а также базовую статистику использования ресурсов.","operationId":"billingInfoGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Информация об аккаунте","schema":{"type":"array","title":"Информация об аккаунте","items":{"$ref":"#/definitions/inline_response_200_1"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/billing/limits":{"get":{"tags":["Аккаунт - биллинг, свойства и статус"],"summary":"Получить ограничения аккаунта","operationId":"billingLimitsGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Ограничения аккаунта","schema":{"$ref":"#/definitions/ "}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/database/list":{"get":{"tags":["Базы данных - MySQL / Postgres"],"summary":"Список аккаунтов в базах данных UNIX","description":"Возвращает список зарегистрированных аккаунтов в базах данных MySQL и Postgres. Для вычисления имени домена необходимо объединить имя базы данных,\n\t идентификатор сервера и суффикс (поле url_suffix). Например, если ID сервера равен 123 (значит это MySQL — см. описание поля 'server' в ответе), а суффикс равен '1gb.ru', то домен\n\t для доступа будет равен 'mysql123.1gb.ru'.","operationId":"databaseListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список аккаунтов","schema":{"type":"array","title":"Список аккаунтов","items":{"$ref":"#/definitions/inline_response_200_2"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"MySQLPostgres"}},"/dns/add":{"get":{"tags":["DNS - доменные имена, привязки"],"summary":"Создание записи домена","operationId":"dnsAddGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"add_dns_zone","in":"query","description":"зона, которую необходимо создать","required":true,"type":"string"},{"name":"add_dns_record","in":"query","description":"","required":false,"type":"string"},{"name":"iis_site_for_dns","in":"query","description":"ID сайта из /website/list, либо IP-адрес виртуального сервера, к которому необходимо сделать привязку","required":false,"type":"string"},{"name":"bind_only","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/dns/bind":{"get":{"tags":["DNS - доменные имена, привязки"],"summary":"Привязка одного домена к другому","operationId":"dnsBindGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID домена из списка /dns/list","required":true,"type":"integer"},{"name":"bind_to","in":"query","description":"домен, к которому необходимо сделать привязку","required":false,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/dns/list":{"get":{"tags":["DNS - доменные имена, привязки"],"summary":"Получить список доменных имён","operationId":"dnsListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список доменных имён","schema":{"type":"array","title":"Список доменных имён","items":{"$ref":"#/definitions/inline_response_200_3"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/dns/prolong/list":{"get":{"tags":["DNS - доменные имена, привязки","Аккаунт - биллинг, свойства и статус"],"summary":"Информация по продлению доменов","operationId":"dnsProlongListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Информация по продлению доменов","schema":{"type":"array","title":"Информация по продлению доменов","items":{"$ref":"#/definitions/inline_response_200_4"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/dns/raw":{"get":{"tags":["DNS - доменные имена, привязки"],"summary":"Редактирование \"сырой\" зоны","operationId":"dnsRawGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID домена из /dns/list","required":true,"type":"integer"},{"name":"s_del","in":"query","description":"Значение '1' сообщает, что запись необходимо удалить","required":true,"type":"integer"},{"name":"s_add","in":"query","description":"Значение '1' сообщает, что запись необходимо создать","required":true,"type":"integer"},{"name":"dns_type","in":"query","description":"Тип записи: A, MX, CNAME, AAAA, NS, TXT, SRV","required":true,"type":"string"},{"name":"dns_name","in":"query","description":"Имя записи, либо '@' для корневой","required":true,"type":"string"},{"name":"dns_value","in":"query","description":"Содержание записи (для A это IP-адрес, для CNAME имя, для MX приоритет и назначение)","required":true,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/dns/raw/managedmx":{"get":{"tags":["DNS - доменные имена, привязки"],"summary":"Редактировать DNS-зону","operationId":"dnsRawManagedmxGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID домена из /dns/list","required":true,"type":"integer"},{"name":"managed_mx","in":"query","description":"Значение '1', если необходимо включить поддержку на MX-серверах хостинга и '0', если выключить","required":true,"type":"integer"},{"name":"upd_managed_mx","in":"query","description":"Значение '1' подтверждает операцию","required":true,"type":"integer"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"DNS"}},"/email/add":{"get":{"tags":["Электронная почта - почтовые ящики"],"summary":"Создание почтового ящика","operationId":"emailAddGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"add_email","in":"query","description":"Адрес почтового ящика, который необходимо создать","required":true,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/email/alias/delete":{"get":{"tags":["Электронная почта - почтовые ящики"],"summary":"Удаление псевдонимов почтовых ящиков","operationId":"emailAliasDeleteGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"Адрес почтового ящика, подлежащего удалению","required":true,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/email/alias/list":{"get":{"tags":["Электронная почта - почтовые ящики"],"summary":"Получить список псевдонимов почтовых ящиков","operationId":"emailAliasListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список псевдонимов почтовых ящиков","schema":{"type":"array","title":"Список псевдонимов почтовых ящиков","items":{"$ref":"#/definitions/inline_response_200_5"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/email/delete":{"get":{"tags":["Электронная почта - почтовые ящики"],"summary":"Удаление почтового ящика","operationId":"emailDeleteGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"Адрес почтового ящика, подлежащего удалению","required":true,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/email/list":{"get":{"tags":["Электронная почта - почтовые ящики"],"summary":"Получить список почтовых ящиков","operationId":"emailListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список почтовых ящиков","schema":{"type":"array","title":"Список почтовых ящиков","items":{"$ref":"#/definitions/inline_response_200_6"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/ftp/list":{"get":{"tags":["Веб-сайты - hosting_ftp (внутреннее API)"],"summary":"Получить список зарегистрированных аккаунтов FTP","operationId":"ftpListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список FTP-аккаунтов","schema":{"type":"array","title":"Список FTP-аккаунтов","items":{"$ref":"#/definitions/inline_response_200_7"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"HostingftpAPI"}},"/iis/list":{"get":{"tags":["Веб-сайты - hosting_iis (внутреннее API)"],"summary":"Список сайтов IIS","operationId":"iisListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список сайтов","schema":{"type":"array","title":"Список сайтов","items":{"$ref":"#/definitions/inline_response_200_8"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"HostingiisAPI"}},"/mssql/list":{"get":{"tags":["Базы данных - Microsoft SQL Server"],"summary":"Получить список аккаунтов в MSSQL","operationId":"mssqlListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список аккаунтов MSSQL","schema":{"type":"array","title":"Список аккаунтов MSSQL","items":{"$ref":"#/definitions/inline_response_200_9"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"MicrosoftSQLServer"}},"/updates/last":{"get":{"tags":["Аккаунт - аудит аккаунта (события)"],"summary":"Идентификатор последнего уведомления в аудите","operationId":"updatesLastGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Идентификатор последнего уведомления в аудите","schema":{"type":"integer"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/updates/list":{"get":{"tags":["Аккаунт - аудит аккаунта (события)"],"summary":"Список записей аудита","operationId":"updatesListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID первой записи для показа или 0 для показа всех записей","required":true,"type":"integer"}],"responses":{"200":{"description":"Список записей аудита","schema":{"type":"array","title":"Список записей аудита","items":{"$ref":"#/definitions/inline_response_200_10"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/vds/create":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Изменение параметров VDS","description":"Изменение параметров уже существующего VDS","operationId":"vdsCreateGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"type","in":"query","description":"Тип создаваемого VDS. 'vz1', 'vz2', 'vz3', 'vz4', 'vz5' или 'vds.dynamic'. По умолчанию 'vds.dynamic'","required":false,"type":"string"},{"name":"cr_hvmem","in":"query","description":"Количество доступной памяти в мегабайтах. По умолчанию 2048","required":false,"type":"integer"},{"name":"cr_hvdsk","in":"query","description":"Количество доступных гигабайт диска. По умолчанию 30","required":false,"type":"integer"},{"name":"cr_hvcpu","in":"query","description":"Количество ядер CPU. По умолчанию 2","required":false,"type":"integer"},{"name":"template","in":"query","description":"Шаблон и тип виртуализации VDS. За подробностями см. /vds/templates-list","required":false,"type":"string"},{"name":"force_memo","in":"query","description":"","required":false,"type":"string"},{"name":"hv_1gb_panel_version","in":"query","description":"","required":false,"type":"string"},{"name":"panel_install","in":"query","description":"Необходимо ли установить панель 1Gb на VDS","required":false,"type":"boolean"},{"name":"cr_ssd1","in":"query","description":"Создать всю систему на SSD","required":false,"type":"boolean"},{"name":"cr_hv_all_system","in":"query","description":"Создать всю систему на одном диске большого размера (иначе — системный диск + диск с данными)","required":false,"type":"boolean"}],"responses":{"200":{"description":"ID VDS","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/delete":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Удаление VDS","description":"Предоставляет функционал для удаления VDS","operationId":"vdsDeleteGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":true,"type":"integer"},{"name":"force_critical","in":"query","description":"Если true, VDS будет удален срочно","required":false,"type":"boolean"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/ip/add":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Добавление IP на VDS","description":"Этот вызов позволяет добавить ещё один IP адрес на указанный VDS","operationId":"vdsIpAddGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":true,"type":"integer"}],"responses":{"200":{"description":"IP-адрес успешно добавлен","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/ip/delete":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Удаление IP с VDS","description":"Этот вызов позволяет отвязать IP адрес от VDS","operationId":"vdsIpDeleteGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":true,"type":"integer"},{"name":"del_ip","in":"query","description":"IP адрес, который необходимо удалить","required":true,"type":"string"}],"responses":{"200":{"description":"IP-адрес успешно удалён","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/ip/list":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Список IP-адресов виртуальных серверов","description":"Список IP-адресов виртуальных серверов","operationId":"vdsIpListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":false,"type":"integer"}],"responses":{"200":{"description":"Список IP-адресов виртуальных серверов","schema":{"type":"array","title":"Список IP-адресов виртуальных серверов","items":{"$ref":"#/definitions/inline_response_200_11"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/list":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Список виртуальных серверов","description":"Позволяет получить список виртуальных серверов","operationId":"vdsListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера. Если задан, то будет выдана информация только для этого VDS","required":false,"type":"integer"}],"responses":{"200":{"description":"Список виртуальных серверов","schema":{"type":"array","title":"Список виртуальных серверов","items":{"$ref":"#/definitions/inline_response_200_12"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/reboot":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Перезагрузка VDS","description":"Предоставляет функционал для перезагрузки VDS","operationId":"vdsRebootGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":true,"type":"integer"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/templates-list":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Список шаблонов виртуальных серверов","description":"Позволяет получить список шаблонов виртуальных серверов","operationId":"vdsTemplates_listGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список шаблонов виртуальных серверов","schema":{"type":"array","title":"Список шаблонов виртуальных серверов","items":{"$ref":"#/definitions/inline_response_200_13"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/vds/update":{"get":{"tags":["VDS - виртуальные сервера Hyper-V / OpenVZ"],"summary":"Создание VDS","description":"Создание новых VDS с произвольными характеристиками","operationId":"vdsUpdateGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID виртуального сервера, полученный из /vds/list","required":true,"type":"integer"},{"name":"cr_hvmem","in":"query","description":"Количество доступной памяти в мегабайтах. По умолчанию 2048","required":false,"type":"integer"},{"name":"cr_hvdsk","in":"query","description":"Количество доступных гигабайт диска. По умолчанию 30","required":false,"type":"integer"},{"name":"cr_hvcpu","in":"query","description":"Количество ядер CPU. По умолчанию 2","required":false,"type":"integer"}],"responses":{"200":{"description":"Параметры VDS успешно обновлены","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":"VDSHyperVOpenVZ"}},"/website/delete":{"get":{"tags":["Веб-сайты - список, свойства, статусы"],"summary":"Удаление сайта","operationId":"websiteDeleteGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"},{"name":"_key_","in":"query","description":"ID сайта, полученный из /website/list","required":true,"type":"string"}],"responses":{"200":{"description":"Возврат строки 'OK' означает успех операции","schema":{"type":"string"}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}},"/website/list":{"get":{"tags":["Веб-сайты - список, свойства, статусы"],"summary":"Список сайтов аккаунта","operationId":"websiteListGET","parameters":[{"name":"_token_","in":"query","description":"Ключ доступа, полученный при авторизации","required":true,"type":"string"}],"responses":{"200":{"description":"Список сайтов аккаунта","schema":{"type":"array","title":"Список сайтов аккаунта","items":{"$ref":"#/definitions/inline_response_200_14"}}},"default":{"description":"Общая ошибка от сервера","schema":{"type":"string"}}},"x-swagger-router-controller":""}}},"definitions":{" ":{"required":["dynamic_content","ftp2","mail","mssql","mysql","php_exec","size","website"],"properties":{"mail":{"type":"string","description":"Ограничение на количество почтовых ящиков. '-' означает отсутствие лимита."},"website":{"type":"string","description":"Ограничение на количество сайтов. '-' означает отсутствие лимита."},"mysql":{"type":"boolean","description":"MySQL разрешен, если true."},"size":{"type":"string","description":"Ограничение на размер дискового пространства. '-' означает отсутствие лимита."},"mssql":{"type":"boolean","description":"MSSQL разрешен, если true."},"dynamic_content":{"type":"boolean","description":"CGI и PHP скрипты разрешены, если true."},"php_exec":{"type":"boolean","description":"Функция exec() в PHP разрешена, если true."},"ftp2":{"type":"string","description":"Ограничение на количество дополнительных FTP логинов. '-' означает отсутствие лимита."}}},"inline_response_200_9":{"required":["db","id","name","pwd","server"],"properties":{"id":{"type":"integer","description":"идентификатор аккаунта"},"db":{"type":"string","description":"имя базы данных"},"server":{"type":"string","description":"адрес сервера"},"name":{"type":"string","description":"логин"},"pwd":{"type":"string","description":"пароль"}}},"inline_response_200_11":{"required":["ip","vds_id"],"properties":{"ip":{"type":"string","description":"IP-адрес"},"vds_id":{"type":"integer","description":"идентификатор VDS"}}},"inline_response_200_10":{"required":["datetime","description","description_plain","id"],"properties":{"id":{"type":"integer","description":"Идентификатор записи"},"datetime":{"type":"string","description":"Дата и время создания записи"},"description":{"type":"string","description":"Тело сообщения (с HTML-тэгами)"},"description_plain":{"type":"string","description":"Тело сообщения (без тэгов)"}}},"inline_response_200_13":{"required":["actual_template","popularity","template","type"],"properties":{"type":{"type":"string","description":"Тип VDS, для которого применим шаблон. Принимает значения 'hv' и 'vz'"},"template":{"type":"string","description":"Имя шаблона"},"popularity":{"type":"integer","description":"Популярность"},"actual_template":{"type":"integer","description":"Актуальность шаблона. 1 = шаблон актуален"}}},"inline_response_200_12":{"required":["deleted","id","online","physical_mac","pwd","stopped","template","type","type_full"],"properties":{"id":{"type":"integer","description":"идентификатор VDS"},"deleted":{"type":"boolean","description":"VDS удалён если true"},"online":{"type":"boolean","description":"VDS работает нормально если true"},"stopped":{"type":"boolean","description":"VDS остановлен если true"},"pwd":{"type":"string","description":"изначальный пароль администратора или root"},"template":{"type":"string","description":"шаблон, на основе которого был создан VDS"},"type_full":{"type":"string","description":"полное описание типа VDS"},"physical_mac":{"type":"string","description":"MAC-адрес VDS"},"type":{"type":"string","description":"тип VDS"}}},"inline_response_200_5":{"required":["alias","id","mail"],"properties":{"id":{"type":"integer","description":"идентификатор псевдонима"},"mail":{"type":"string","description":"почтовый ящик псевдонима"},"alias":{"type":"string","description":"имя псевдонима"}}},"inline_response_200_6":{"required":["archived_count","id","mail","mercury_pwd","mercury_user","online","server_imap","server_pop3","server_smtp","server_webmail","size_amount","size_file_count","status","wm1","wm2"],"properties":{"id":{"type":"integer","description":"идентификатор ящика"},"status":{"type":"integer","description":""},"online":{"type":"boolean","description":"ящик работает, если true"},"mail":{"type":"string","description":"полный адрес ящика"},"mercury_user":{"type":"string","description":"имя пользователя для входа в Mercury"},"mercury_pwd":{"type":"string","description":"пароль для входа в Mercury"},"size_amount":{"type":"integer","description":"текущий размер ящика"},"size_file_count":{"type":"integer","description":"количество файлов, занятых ящиком"},"archived_count":{"type":"integer","description":""},"server_pop3":{"type":"string","description":"адрес сервера для доступа к ящику по POP3"},"server_smtp":{"type":"string","description":"адрес сервера для доступа к ящику по SMTP"},"server_webmail":{"type":"string","description":"адрес сервера Webmail для входа в ящик через браузер"},"server_imap":{"type":"string","description":"адрес сервера для доступа к ящику по IMAP"},"wm1":{"type":"string","description":""},"wm2":{"type":"string","description":""}}},"inline_response_200_7":{"required":["id","name","pwd"],"properties":{"id":{"type":"integer","description":"идентификатор аккаунта"},"name":{"type":"string","description":"логин"},"pwd":{"type":"string","description":"пароль"}}},"inline_response_200_8":{"required":["dns_id","ftp_id","id","online","size_amount","size_file_count","size_file_count_limit"],"properties":{"id":{"type":"integer","description":"идентификатор сайта"},"online":{"type":"boolean","description":"сайт работает нормально если true"},"ftp_id":{"type":"integer","description":"идентификатор связанного аккаунта FTP"},"dns_id":{"type":"integer","description":"идентификатор связанной записи DNS"},"size_amount":{"type":"integer","description":"размер занятого места"},"size_file_count":{"type":"integer","description":"количество файлов"},"size_file_count_limit":{"type":"integer","description":"ограничение на количество файлов"}}},"inline_response_200_14":{"required":["admin_protection","alt_docroot_path","alt_docroot_server","alt_docroot_ssd_req","alt_docroot_status","alt_docroot_status_cnt","alt_docroot_status_date","analyze_analog","apache_generic_pool_port","apache_php_pool1_only","apache_php_pool5_only","apache_php_pooled","apache_php_pooled_ext","apache_php_pooled_ext_auto","apache_ssi","aufs_template","awstats_primary_domain","backup_date","backup_delta_date","backup_delta_desc","backup_delta_stat_date","backup_special_mode","backup_stat_date","base_folder","base_folder_suffix","bind_dtc","block_transfer","bypass_security","content_comments","content_comments_verbose","content_moderated_date","content_moderated_status","copy_logs","cpu_details_enabled","cpu_limit_exceeded_date","date_reg","deleted","deleted_auto","deleted_dump","detected_packages","dns_id","feedback_speed","feedback_speed_dtc","feedback_speed_feedback","flag_free","flag_generic_exec","flag_no_www","ftp_id","ftp_ipfilter","ftp_name","ftp_pwd","global_transfer_count","http_frontend_ip","http_frontend_ip_transition","id","iis_binding","iis_comments","iis_creation_commands","iis_creation_commands_unix","iis_id","iis_path","l3d_auto","live_day_count","mail_accept","mail_drop","mail_limit","memo","meta_save_count","mongrel_environment","net_limit_deny_from_agent","net_limit_deny_from_ip","net_limit_file","online","options_autolimit","rtm_scan_date","scan_date","server","server_aux","server_bak","server_changed_time","server_transition","server_transition_dtc","sharepoint_mode","sharepoint_mode_pending","size_amount","size_check_problem","size_comments","size_date","size_file_count","size_file_count_limit","size_priority_scan","smtp_from","ssh_ipfilter","stat_site_power","status","super_backup_date","thumb_date","thumb_failed","unix_path_on_windows","unmovable","user_id","virtualhost_conf","virtualhost_server","virtualhost_server_conf","wpb_domain","wpb_status","wpb_uuid"],"properties":{"id":{"type":"integer","description":""},"status":{"type":"string","description":""},"unmovable":{"type":"string","description":""},"online":{"type":"string","description":"Включен (активен), если true."},"deleted":{"type":"string","description":"Удален, если true. Данные могут сохраняться."},"deleted_auto":{"type":"string","description":"Удален, если true. Данные могут сохраняться."},"deleted_dump":{"type":"string","description":""},"user_id":{"type":"string","description":""},"ftp_id":{"type":"string","description":""},"dns_id":{"type":"string","description":""},"iis_id":{"type":"string","description":""},"iis_binding":{"type":"string","description":""},"iis_path":{"type":"string","description":""},"iis_comments":{"type":"string","description":"Уникальное строковое имя сайта (ID)."},"memo":{"type":"string","description":""},"date_reg":{"type":"string","description":"Дата создания."},"server":{"type":"string","description":"Тип веб-сервера."},"server_bak":{"type":"string","description":""},"server_aux":{"type":"string","description":""},"server_transition":{"type":"string","description":"Тип сервера недавно изменялся, если true."},"server_transition_dtc":{"type":"string","description":""},"block_transfer":{"type":"string","description":""},"server_changed_time":{"type":"string","description":""},"size_amount":{"type":"string","description":"Размер веб-сайта - объем (Кб)."},"size_file_count":{"type":"string","description":"Размер веб-сайта - кол-во файлов."},"size_file_count_limit":{"type":"string","description":""},"size_date":{"type":"string","description":"Размер веб-сайта - дата замера."},"size_priority_scan":{"type":"string","description":""},"copy_logs":{"type":"string","description":""},"content_comments":{"type":"string","description":""},"content_comments_verbose":{"type":"string","description":""},"meta_save_count":{"type":"string","description":""},"base_folder":{"type":"string","description":""},"virtualhost_conf":{"type":"string","description":""},"virtualhost_server":{"type":"string","description":""},"virtualhost_server_conf":{"type":"string","description":""},"live_day_count":{"type":"string","description":""},"scan_date":{"type":"string","description":""},"global_transfer_count":{"type":"string","description":""},"net_limit_file":{"type":"string","description":""},"net_limit_deny_from_ip":{"type":"string","description":""},"net_limit_deny_from_agent":{"type":"string","description":""},"apache_php_pooled":{"type":"string","description":""},"apache_php_pooled_ext":{"type":"string","description":""},"apache_php_pooled_ext_auto":{"type":"string","description":""},"apache_php_pool1_only":{"type":"string","description":""},"apache_php_pool5_only":{"type":"string","description":""},"apache_ssi":{"type":"string","description":""},"bypass_security":{"type":"string","description":""},"flag_generic_exec":{"type":"string","description":""},"flag_no_www":{"type":"string","description":""},"base_folder_suffix":{"type":"string","description":""},"feedback_speed":{"type":"string","description":""},"feedback_speed_dtc":{"type":"string","description":""},"feedback_speed_feedback":{"type":"string","description":""},"unix_path_on_windows":{"type":"string","description":""},"ftp_ipfilter":{"type":"string","description":"Ограничение по IP адресам - FTP доступ."},"ssh_ipfilter":{"type":"string","description":"Ограничение по IP адресам - SSH доступ."},"l3d_auto":{"type":"string","description":""},"awstats_primary_domain":{"type":"string","description":""},"sharepoint_mode":{"type":"string","description":""},"sharepoint_mode_pending":{"type":"string","description":""},"apache_generic_pool_port":{"type":"string","description":""},"mongrel_environment":{"type":"string","description":""},"flag_free":{"type":"string","description":""},"rtm_scan_date":{"type":"string","description":""},"analyze_analog":{"type":"string","description":""},"cpu_details_enabled":{"type":"string","description":"Включен режим предоставления детализации процессорной нагрузки."},"content_moderated_status":{"type":"string","description":""},"content_moderated_date":{"type":"string","description":""},"http_frontend_ip":{"type":"string","description":""},"http_frontend_ip_transition":{"type":"string","description":""},"cpu_limit_exceeded_date":{"type":"string","description":"Дата последнего превышения процессорной нагрузки."},"aufs_template":{"type":"string","description":"Признак сайта-конструктора."},"options_autolimit":{"type":"string","description":""},"iis_creation_commands":{"type":"string","description":"Версия ASP.NET, если отлична от 2.0."},"iis_creation_commands_unix":{"type":"string","description":""},"thumb_date":{"type":"string","description":""},"thumb_failed":{"type":"string","description":""},"backup_stat_date":{"type":"string","description":""},"backup_date":{"type":"string","description":"Дата пофайловой резервной копии."},"detected_packages":{"type":"string","description":""},"stat_site_power":{"type":"string","description":""},"smtp_from":{"type":"string","description":""},"super_backup_date":{"type":"string","description":""},"backup_delta_stat_date":{"type":"string","description":""},"backup_delta_date":{"type":"string","description":"Дата архивной резервной копии."},"backup_delta_desc":{"type":"string","description":"Содержимое архивной резервной копии."},"alt_docroot_server":{"type":"string","description":""},"alt_docroot_path":{"type":"string","description":""},"alt_docroot_status":{"type":"string","description":""},"alt_docroot_status_cnt":{"type":"string","description":""},"alt_docroot_status_date":{"type":"string","description":""},"bind_dtc":{"type":"string","description":"Последнее изменение привязок доменов для сайта."},"backup_special_mode":{"type":"string","description":""},"size_check_problem":{"type":"string","description":""},"wpb_domain":{"type":"string","description":""},"wpb_uuid":{"type":"string","description":"Для сайта включен конструктор Parallels WPB."},"wpb_status":{"type":"string","description":""},"admin_protection":{"type":"string","description":""},"size_comments":{"type":"string","description":""},"alt_docroot_ssd_req":{"type":"string","description":""},"mail_limit":{"type":"string","description":""},"mail_accept":{"type":"string","description":""},"mail_drop":{"type":"string","description":""},"ftp_name":{"type":"string","description":"FTP/SSH/SCP/SFTP логин."},"ftp_pwd":{"type":"string","description":"FTP/SSH/SCP/SFTP пароль."}}},"inline_response_200_1":{"required":["__expires","__period_months","__period_price","__plan_name","billing_group_id","blocked","client_id","client_login","contract_id","contract_type","credit_limit","description","email","external_currency_spelled_prefix","external_currency_spelled_suffix","id","name_eng","name_rus","period_id","plan_id","stat_access_dynamic","stat_access_static","stat_access_traffic","stat_emails","stat_mysqls","stat_nicd","stat_paid_total","stat_sites","stat_size_mb","stat_tech","stat_vds_size"],"properties":{"id":{"type":"integer","description":"Идентификатор аккаунта"},"description":{"type":"string","description":"Описание аккаунта"},"billing_group_id":{"type":"integer","description":"Идентификатор тарифной группы"},"blocked":{"type":"string","description":"Аккаунт заблокирован, если true"},"blocked_date":{"type":"string","description":"Дата блокировки"},"blocked_reason":{"type":"string","description":"Причина блокировки"},"credit_limit":{"type":"number","description":"Ограничение суммы на работу в аванс"},"plan_id":{"type":"integer","description":"Идентификатор тарифа"},"period_id":{"type":"integer","description":"Идентификатор тарифа (периода)"},"contract_type":{"type":"integer","description":"Тип договора"},"client_id":{"type":"integer","description":""},"client_login":{"type":"string","description":"Логин клиента"},"contract_id":{"type":"string","description":"Номер договора"},"name_rus":{"type":"string","description":"Имя клиента на русском"},"name_eng":{"type":"string","description":"Имя клиента на английском"},"email":{"type":"string","description":"E-mail клиент"},"stat_sites":{"type":"integer","description":"Количество созданных сайтов"},"stat_size_mb":{"type":"integer","description":"Используемое дисковое пространство"},"stat_emails":{"type":"integer","description":"Количество созданных почтовых ящиков"},"stat_mysqls":{"type":"integer","description":"Количество баз данных MySQL"},"stat_tech":{"type":"integer","description":""},"stat_nicd":{"type":"integer","description":""},"stat_access_dynamic":{"type":"integer","description":""},"stat_access_static":{"type":"integer","description":""},"stat_access_traffic":{"type":"integer","description":""},"stat_paid_total":{"type":"integer","description":""},"stat_vds_size":{"type":"integer","description":"Размер дисков VDS"},"__plan_name":{"type":"string","description":"Название тарифного плана"},"__period_months":{"type":"integer","description":"Количество месяцев в оплаченном периоде"},"__period_price":{"type":"number","description":"Стоимость оплаченного периода"},"__expires":{"type":"string","description":""},"external_currency_spelled_prefix":{"type":"string","description":"Префикс для вывода текущей валюты хостинга (например, в строке '$100' префиксом является '$')"},"external_currency_spelled_suffix":{"type":"string","description":"Суффикс для вывода текущей валюты хостинга (например, в строке '100 руб.' суффиксом является ' руб.'"}}},"inline_response_200":{"required":["block_date","last_month_debt_sum","last_month_debt_sum2","negative_balance_days","negative_balance_days_lic"],"properties":{"negative_balance_days":{"type":"integer","description":"Планируемое количество дней до наступления негативного баланса"},"negative_balance_days_lic":{"type":"integer","description":"Планируемое количество дней до наступления негативного баланса по аккаунту лицензий"},"last_month_debt_sum":{"type":"number","description":""},"last_month_debt_sum2":{"type":"number","description":""},"block_date":{"type":"string","description":"Дата блокировки аккаунта"}}},"inline_response_200_2":{"required":["id","name","pwd","server","url_suffix"],"properties":{"id":{"type":"integer","description":"идентификатор аккаунта"},"name":{"type":"string","description":"логин"},"server":{"type":"string","description":"идентификатор сервера. Если равен или больше 10000, то это Postgres. Иначе MySQL"},"pwd":{"type":"string","description":"пароль"},"url_suffix":{"type":"string","description":"суффикс домена сервера"}}},"inline_response_200_3":{"required":["addr1","full_domain_name","full_domain_name_local","id","iis_id","online","zone"],"properties":{"id":{"type":"integer","description":"идентификатор домена"},"iis_id":{"type":"integer","description":"идентификатор связанной записи IIS"},"online":{"type":"boolean","description":"домен работает, если true"},"full_domain_name":{"type":"string","description":"полное имя домена"},"full_domain_name_local":{"type":"string","description":""},"addr1":{"type":"string","description":""},"zone":{"type":"string","description":"зона домена"}}},"inline_response_200_4":{"required":["date_updated","domain_addr","end_date","expires_countdown","nservers","object_state","payed_till","record_created","subject_contract"],"properties":{"date_updated":{"type":"string","description":"Дата последнего обновления домена"},"record_created":{"type":"string","description":"Дата создания записи"},"subject_contract":{"type":"string","description":""},"end_date":{"type":"string","description":""},"payed_till":{"type":"string","description":"Дата, до которой оплачен домен"},"object_state":{"type":"string","description":""},"domain_addr":{"type":"string","description":"Имя домена"},"nservers":{"type":"string","description":"Сервера имён домена"},"expires_countdown":{"type":"integer","description":"Количество дней до окончания срока действия домена"}}}}}