1Gb API

API для работы с хостингом позволяет автоматизировать управление ресурсами и анализ данных. ## Примеры использования API хостинга: * Отслеживание состояния аккаунта и своевременный анализ уведомлений * Автоматическое создание, удаление, конфигурирование ресурсов * Доступ к данным внутреннего мониторинга 1Gb.ru, анализ качества работы VDS * Автоматизация типовых реакций на проблемы ресурсов и хостинга Доступ к API хостинга активен в любом оплаченном тарифном плане. Для тестовых или бесплатных аккаунтов API не работает. ## Принципы работы и примеры Доступ происходит по протоколу HTTPS по базовому адресу https://www.1gb.ru/api/. Параметры большинства запросов можно передавать с помощью GET или POST параметров. Ответ содержит объект или массив объектов по стандарту JSON. Перед началом работы с API требуется получить token для дальнейшей авторизации. Это делается следующим образом (приведены примеры использования GET параметров): 1. https://www.1gb.ru/api/auth/start?login=[логин_кабинета] - возвращает в ответ string, содержащий соль 2. https://www.1gb.ru/api/auth/login?login=[логин_кабинета]&salt=[соль]&response=[response] - возвращает в ответ string, содержащий token; псевдокод для вычисления response на PHP: *md5($password.$salt.\"\\n\")* (сумма md5 строки \"пароль+соль+символ-перевода-строки\") Последний запрос возвращает string, в нем token, его нужно запомнить и использовать для последующей авторизации. Token утрачивает силу при смене главного пароля аккаунта, существует также возможность деактивировать отдельные token-ы со страницы кабинета \"смена главного пароля аккаунта\". Примеры дальнейших запросов: https://www.1gb.ru/api/billing/info?_token_=[запомненный token] - получение общих данных аккаунта Ответы API с HTTP кодом 200 обозначают успешное исполнение операции. В ответном JSON может содержаться два разных типа: * [ \"string\" ]: либо просто \"OK\", либо \"[число]\" (необходимо привести к int), если возвращается ID созданного объекта * [ { ... } , { ... } ] (массив объектов): если запрос возвращает список из 0 или более структур (хеш \"поле\":\"значение\"). Другие коды (больше 200) обозначают ошибку, при этом тело ответа содержит string с объяснением, пример: \"ERROR: vds.missing\". ## Команды API и общие соглашения Большинство команд API, таких как /list, возвращают внутренние структуры из базы данных хостинга, которые содержат сотни полей. Документировать их трудоемко, поэтому рекомендуем просто смотреть на вывод соответствующих команд и анализировать структуры данных по очевидным названиям полей. В том случае, если трактовка полей вызывает затруднения, пишите на support@1gb.ru, поможем разобраться. ## Общедоступные на данный момент команды https://www.1gb.ru/api + адрес из списка ниже. Обязательный параметр каждой команды (кроме этапа авторизации) - _token_. Остальные параметры приведены после команды.
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 2.0.0
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /balance
  2. get /balance.lic
  3. get /billing/debt
  4. get /billing/info
  5. get /billing/limits
  6. get /dns/prolong/list
  7. get /email/add
  8. get /email/alias/delete
  9. get /email/alias/list
  10. get /email/delete
  11. get /email/list
  12. get /updates/last
  13. get /updates/list
  14. get /website/delete
  15. get /website/list
  16. post /auth/login
  17. get /auth/start
  18. get /dns/add
  19. get /dns/bind
  20. get /dns/list
  21. get /dns/prolong/list
  22. get /dns/raw
  23. get /dns/raw/managedmx
  24. get /ftp/list
  25. get /iis/list
  26. get /mssql/list
  27. get /database/list
  28. get /vds/create
  29. get /vds/delete
  30. get /vds/ip/add
  31. get /vds/ip/delete
  32. get /vds/ip/list
  33. get /vds/list
  34. get /vds/reboot
  35. get /vds/templates-list
  36. get /vds/update
Up 
get /balance
Аккаунт: баланс (balanceGet)
Возвращает текущий баланс аккаунта

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

BigDecimal

Example data

Content-Type: application/json
1.3579000000000001069366817318950779736042022705078125

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Текущий баланс аккаунта хостинга BigDecimal

0

Общая ошибка от сервера String
Up 
get /balance.lic
Аккаунт: баланс аккаунта лицензий (balanceLicGet)
Возвращает текущий баланс аккаунта лицензий

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

BigDecimal

Example data

Content-Type: application/json
1.3579000000000001069366817318950779736042022705078125

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Текущий баланс аккаунта лицензий BigDecimal

0

Общая ошибка от сервера String
Up 
get /billing/debt
Информация по дебету аккаунта (billingDebtGet)
Данный запрос позволяет получить информацию по планируемым датам наступления негативного баланса и отключения

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200]

Example data

Content-Type: application/json
[ {
  "last_month_debt_sum2" : 1.3579000000000001069366817318950779736042022705078125,
  "negative_balance_days" : "",
  "last_month_debt_sum" : 1.3579000000000001069366817318950779736042022705078125,
  "block_date" : "aeiou",
  "negative_balance_days_lic" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по дебету аккаунта

0

Общая ошибка от сервера String
Up 
get /billing/info
Информация об аккаунте (billingInfoGet)
Этот запрос позволяет получить информацию об аккаунте, а также базовую статистику использования ресурсов.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_1]

Example data

Content-Type: application/json
[ {
  "stat_tech" : "",
  "stat_nicd" : "",
  "contract_id" : "aeiou",
  "description" : "aeiou",
  "external_currency_spelled_prefix" : "aeiou",
  "client_id" : "",
  "stat_vds_size" : "",
  "client_login" : "aeiou",
  "name_eng" : "aeiou",
  "stat_emails" : "",
  "blocked" : "aeiou",
  "stat_mysqls" : "",
  "credit_limit" : 1.3579000000000001069366817318950779736042022705078125,
  "stat_access_static" : "",
  "__period_price" : 1.3579000000000001069366817318950779736042022705078125,
  "id" : "",
  "external_currency_spelled_suffix" : "aeiou",
  "period_id" : "",
  "email" : "aeiou",
  "name_rus" : "aeiou",
  "stat_sites" : "",
  "blocked_date" : "aeiou",
  "__period_months" : "",
  "__plan_name" : "aeiou",
  "billing_group_id" : "",
  "contract_type" : "",
  "blocked_reason" : "aeiou",
  "stat_access_dynamic" : "",
  "stat_access_traffic" : "",
  "stat_size_mb" : "",
  "stat_paid_total" : "",
  "plan_id" : "",
  "__expires" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация об аккаунте

0

Общая ошибка от сервера String
Up 
get /billing/limits
Получить ограничения аккаунта (billingLimitsGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

Example data

Content-Type: application/json
{
  "ftp2" : "aeiou",
  "website" : "aeiou",
  "mail" : "aeiou",
  "size" : "aeiou",
  "mysql" : true,
  "dynamic_content" : true,
  "php_exec" : true,
  "mssql" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ограничения аккаунта

0

Общая ошибка от сервера String
Up 
get /dns/prolong/list
Информация по продлению доменов (dnsProlongListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_4]

Example data

Content-Type: application/json
[ {
  "end_date" : "aeiou",
  "domain_addr" : "aeiou",
  "date_updated" : "aeiou",
  "record_created" : "aeiou",
  "payed_till" : "aeiou",
  "expires_countdown" : "",
  "nservers" : "aeiou",
  "subject_contract" : "aeiou",
  "object_state" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по продлению доменов

0

Общая ошибка от сервера String
Up 
get /email/add
Создание почтового ящика (emailAddGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
add_email (required)
Query Parameter — Адрес почтового ящика, который необходимо создать

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /email/alias/delete
Удаление псевдонимов почтовых ящиков (emailAliasDeleteGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — Адрес почтового ящика, подлежащего удалению

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /email/alias/list
Получить список псевдонимов почтовых ящиков (emailAliasListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_5]

Example data

Content-Type: application/json
[ {
  "mail" : "aeiou",
  "alias" : "aeiou",
  "id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список псевдонимов почтовых ящиков

0

Общая ошибка от сервера String
Up 
get /email/delete
Удаление почтового ящика (emailDeleteGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — Адрес почтового ящика, подлежащего удалению

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /email/list
Получить список почтовых ящиков (emailListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_6]

Example data

Content-Type: application/json
[ {
  "archived_count" : "",
  "mail" : "aeiou",
  "server_imap" : "aeiou",
  "mercury_pwd" : "aeiou",
  "size_amount" : "",
  "size_file_count" : "",
  "mercury_user" : "aeiou",
  "online" : true,
  "server_pop3" : "aeiou",
  "server_smtp" : "aeiou",
  "wm1" : "aeiou",
  "id" : "",
  "server_webmail" : "aeiou",
  "wm2" : "aeiou",
  "status" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список почтовых ящиков

0

Общая ошибка от сервера String
Up 
get /updates/last
Идентификатор последнего уведомления в аудите (updatesLastGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

Integer

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Идентификатор последнего уведомления в аудите Integer

0

Общая ошибка от сервера String
Up 
get /updates/list
Список записей аудита (updatesListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID первой записи для показа или 0 для показа всех записей

Return type

array[inline_response_200_10]

Example data

Content-Type: application/json
[ {
  "datetime" : "aeiou",
  "description_plain" : "aeiou",
  "description" : "aeiou",
  "id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список записей аудита

0

Общая ошибка от сервера String
Up 
get /website/delete
Удаление сайта (websiteDeleteGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID сайта, полученный из /website/list

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /website/list
Список сайтов аккаунта (websiteListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_14]

Example data

Content-Type: application/json
[ {
  "detected_packages" : "aeiou",
  "cpu_limit_exceeded_date" : "aeiou",
  "memo" : "aeiou",
  "sharepoint_mode" : "aeiou",
  "backup_delta_desc" : "aeiou",
  "dns_id" : "aeiou",
  "id" : "",
  "scan_date" : "aeiou",
  "backup_stat_date" : "aeiou",
  "http_frontend_ip_transition" : "aeiou",
  "backup_delta_stat_date" : "aeiou",
  "admin_protection" : "aeiou",
  "cpu_details_enabled" : "aeiou",
  "size_amount" : "aeiou",
  "alt_docroot_server" : "aeiou",
  "backup_delta_date" : "aeiou",
  "alt_docroot_status" : "aeiou",
  "super_backup_date" : "aeiou",
  "user_id" : "aeiou",
  "alt_docroot_path" : "aeiou",
  "feedback_speed_dtc" : "aeiou",
  "analyze_analog" : "aeiou",
  "status" : "aeiou",
  "server_bak" : "aeiou",
  "server" : "aeiou",
  "iis_comments" : "aeiou",
  "apache_generic_pool_port" : "aeiou",
  "block_transfer" : "aeiou",
  "apache_php_pooled_ext_auto" : "aeiou",
  "mail_accept" : "aeiou",
  "size_file_count" : "aeiou",
  "ssh_ipfilter" : "aeiou",
  "live_day_count" : "aeiou",
  "l3d_auto" : "aeiou",
  "flag_no_www" : "aeiou",
  "base_folder" : "aeiou",
  "size_comments" : "aeiou",
  "iis_binding" : "aeiou",
  "apache_php_pool1_only" : "aeiou",
  "iis_creation_commands_unix" : "aeiou",
  "date_reg" : "aeiou",
  "server_transition" : "aeiou",
  "apache_php_pooled" : "aeiou",
  "flag_generic_exec" : "aeiou",
  "aufs_template" : "aeiou",
  "size_check_problem" : "aeiou",
  "net_limit_file" : "aeiou",
  "deleted" : "aeiou",
  "backup_special_mode" : "aeiou",
  "feedback_speed" : "aeiou",
  "global_transfer_count" : "aeiou",
  "copy_logs" : "aeiou",
  "wpb_uuid" : "aeiou",
  "sharepoint_mode_pending" : "aeiou",
  "iis_creation_commands" : "aeiou",
  "smtp_from" : "aeiou",
  "content_comments_verbose" : "aeiou",
  "meta_save_count" : "aeiou",
  "unmovable" : "aeiou",
  "deleted_auto" : "aeiou",
  "bypass_security" : "aeiou",
  "ftp_ipfilter" : "aeiou",
  "thumb_failed" : "aeiou",
  "alt_docroot_status_cnt" : "aeiou",
  "virtualhost_server_conf" : "aeiou",
  "stat_site_power" : "aeiou",
  "net_limit_deny_from_agent" : "aeiou",
  "http_frontend_ip" : "aeiou",
  "content_comments" : "aeiou",
  "iis_id" : "aeiou",
  "wpb_domain" : "aeiou",
  "unix_path_on_windows" : "aeiou",
  "content_moderated_date" : "aeiou",
  "size_date" : "aeiou",
  "server_changed_time" : "aeiou",
  "ftp_id" : "aeiou",
  "backup_date" : "aeiou",
  "options_autolimit" : "aeiou",
  "base_folder_suffix" : "aeiou",
  "size_priority_scan" : "aeiou",
  "apache_php_pool5_only" : "aeiou",
  "apache_ssi" : "aeiou",
  "wpb_status" : "aeiou",
  "server_transition_dtc" : "aeiou",
  "content_moderated_status" : "aeiou",
  "bind_dtc" : "aeiou",
  "size_file_count_limit" : "aeiou",
  "virtualhost_conf" : "aeiou",
  "alt_docroot_status_date" : "aeiou",
  "deleted_dump" : "aeiou",
  "mail_limit" : "aeiou",
  "thumb_date" : "aeiou",
  "ftp_name" : "aeiou",
  "ftp_pwd" : "aeiou",
  "iis_path" : "aeiou",
  "server_aux" : "aeiou",
  "awstats_primary_domain" : "aeiou",
  "feedback_speed_feedback" : "aeiou",
  "alt_docroot_ssd_req" : "aeiou",
  "mail_drop" : "aeiou",
  "flag_free" : "aeiou",
  "mongrel_environment" : "aeiou",
  "virtualhost_server" : "aeiou",
  "net_limit_deny_from_ip" : "aeiou",
  "online" : "aeiou",
  "rtm_scan_date" : "aeiou",
  "apache_php_pooled_ext" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список сайтов аккаунта

0

Общая ошибка от сервера String
Up 
post /auth/login
Получить ключ доступа (authLoginPost)
Возвращает ключ доступа, с которым в дальнейшем будут осуществляться всё взаимодействие с API (параметр 'token'). Для вычисления значения параметра 'response' необходимо получить представленную в hex MD5-сумму от объединения строк пароля пользователя, полученной соли и символа переноса строки. Псевдокод операции: hex(md5(password + salt + '\\n'))

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

login (required)
Query Parameter — Имя пользователя
salt (required)
Query Parameter — Соль (см. /auth/start)
response (required)
Query Parameter — Вычисленный хэш

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Ключ доступа String

0

Общая ошибка от сервера String
Up 
get /auth/start
Получить соль (authStartGet)
Возвращает соль для авторизации. Это первый этап идентификации пользователя. Затем соль используется во втором, окончательном этапе авторизации, в запросе /auth/login. Запрос не требует дополнительных параметров.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

login (required)
Query Parameter — Имя пользователя

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Соль для авторизации String

0

Общая ошибка от сервера String
Up 
get /dns/add
Создание записи домена (dnsAddGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
add_dns_zone (required)
Query Parameter — зона, которую необходимо создать
add_dns_record (optional)
Query Parameter —
iis_site_for_dns (optional)
Query Parameter — ID сайта из /website/list, либо IP-адрес виртуального сервера, к которому необходимо сделать привязку
bind_only (optional)
Query Parameter —

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /dns/bind
Привязка одного домена к другому (dnsBindGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID домена из списка /dns/list
bind_to (optional)
Query Parameter — домен, к которому необходимо сделать привязку

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /dns/list
Получить список доменных имён (dnsListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_3]

Example data

Content-Type: application/json
[ {
  "full_domain_name_local" : "aeiou",
  "addr1" : "aeiou",
  "zone" : "aeiou",
  "full_domain_name" : "aeiou",
  "online" : true,
  "id" : "",
  "iis_id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список доменных имён

0

Общая ошибка от сервера String
Up 
get /dns/prolong/list
Информация по продлению доменов (dnsProlongListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_4]

Example data

Content-Type: application/json
[ {
  "end_date" : "aeiou",
  "domain_addr" : "aeiou",
  "date_updated" : "aeiou",
  "record_created" : "aeiou",
  "payed_till" : "aeiou",
  "expires_countdown" : "",
  "nservers" : "aeiou",
  "subject_contract" : "aeiou",
  "object_state" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Информация по продлению доменов

0

Общая ошибка от сервера String
Up 
get /dns/raw
Редактирование \"сырой\" зоны (dnsRawGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID домена из /dns/list
s_del (required)
Query Parameter — Значение '1' сообщает, что запись необходимо удалить
s_add (required)
Query Parameter — Значение '1' сообщает, что запись необходимо создать
dns_type (required)
Query Parameter — Тип записи: A, MX, CNAME, AAAA, NS, TXT, SRV
dns_name (required)
Query Parameter — Имя записи, либо '@' для корневой
dns_value (required)
Query Parameter — Содержание записи (для A это IP-адрес, для CNAME имя, для MX приоритет и назначение)

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /dns/raw/managedmx
Редактировать DNS-зону (dnsRawManagedmxGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID домена из /dns/list
managed_mx (required)
Query Parameter — Значение '1', если необходимо включить поддержку на MX-серверах хостинга и '0', если выключить
upd_managed_mx (required)
Query Parameter — Значение '1' подтверждает операцию

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /ftp/list
Получить список зарегистрированных аккаунтов FTP (ftpListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_7]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "id" : "",
  "pwd" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список FTP-аккаунтов

0

Общая ошибка от сервера String
Up 
get /iis/list
Список сайтов IIS (iisListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_8]

Example data

Content-Type: application/json
[ {
  "size_file_count" : "",
  "size_file_count_limit" : "",
  "online" : true,
  "dns_id" : "",
  "id" : "",
  "ftp_id" : "",
  "size_amount" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список сайтов

0

Общая ошибка от сервера String
Up 
get /mssql/list
Получить список аккаунтов в MSSQL (mssqlListGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_9]

Example data

Content-Type: application/json
[ {
  "server" : "aeiou",
  "name" : "aeiou",
  "id" : "",
  "pwd" : "aeiou",
  "db" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список аккаунтов MSSQL

0

Общая ошибка от сервера String
Up 
get /database/list
Список аккаунтов в базах данных UNIX (databaseListGet)
Возвращает список зарегистрированных аккаунтов в базах данных MySQL и Postgres. Для вычисления имени домена необходимо объединить имя базы данных, идентификатор сервера и суффикс (поле url_suffix). Например, если ID сервера равен 123 (значит это MySQL — см. описание поля 'server' в ответе), а суффикс равен '1gb.ru', то домен для доступа будет равен 'mysql123.1gb.ru'.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_2]

Example data

Content-Type: application/json
[ {
  "server" : "aeiou",
  "url_suffix" : "aeiou",
  "name" : "aeiou",
  "id" : "",
  "pwd" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список аккаунтов

0

Общая ошибка от сервера String
Up 
get /vds/create
Изменение параметров VDS (vdsCreateGet)
Изменение параметров уже существующего VDS

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
type (optional)
Query Parameter — Тип создаваемого VDS. 'vz1', 'vz2', 'vz3', 'vz4', 'vz5' или 'vds.dynamic'. По умолчанию 'vds.dynamic'
cr_hvmem (optional)
Query Parameter — Количество доступной памяти в мегабайтах. По умолчанию 2048
cr_hvdsk (optional)
Query Parameter — Количество доступных гигабайт диска. По умолчанию 30
cr_hvcpu (optional)
Query Parameter — Количество ядер CPU. По умолчанию 2
template (optional)
Query Parameter — Шаблон и тип виртуализации VDS. За подробностями см. /vds/templates-list
force_memo (optional)
Query Parameter —
hv_1gb_panel_version (optional)
Query Parameter —
panel_install (optional)
Query Parameter — Необходимо ли установить панель 1Gb на VDS
cr_ssd1 (optional)
Query Parameter — Создать всю систему на SSD
cr_hv_all_system (optional)
Query Parameter — Создать всю систему на одном диске большого размера (иначе — системный диск + диск с данными)

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ID VDS String

0

Общая ошибка от сервера String
Up 
get /vds/delete
Удаление VDS (vdsDeleteGet)
Предоставляет функционал для удаления VDS

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID виртуального сервера, полученный из /vds/list
force_critical (optional)
Query Parameter — Если true, VDS будет удален срочно

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /vds/ip/add
Добавление IP на VDS (vdsIpAddGet)
Этот вызов позволяет добавить ещё один IP адрес на указанный VDS

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID виртуального сервера, полученный из /vds/list

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IP-адрес успешно добавлен String

0

Общая ошибка от сервера String
Up 
get /vds/ip/delete
Удаление IP с VDS (vdsIpDeleteGet)
Этот вызов позволяет отвязать IP адрес от VDS

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID виртуального сервера, полученный из /vds/list
del_ip (required)
Query Parameter — IP адрес, который необходимо удалить

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

IP-адрес успешно удалён String

0

Общая ошибка от сервера String
Up 
get /vds/ip/list
Список IP-адресов виртуальных серверов (vdsIpListGet)
Список IP-адресов виртуальных серверов

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (optional)
Query Parameter — ID виртуального сервера, полученный из /vds/list

Return type

array[inline_response_200_11]

Example data

Content-Type: application/json
[ {
  "ip" : "aeiou",
  "vds_id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список IP-адресов виртуальных серверов

0

Общая ошибка от сервера String
Up 
get /vds/list
Список виртуальных серверов (vdsListGet)
Позволяет получить список виртуальных серверов

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (optional)
Query Parameter — ID виртуального сервера. Если задан, то будет выдана информация только для этого VDS

Return type

array[inline_response_200_12]

Example data

Content-Type: application/json
[ {
  "template" : "aeiou",
  "stopped" : true,
  "deleted" : true,
  "online" : true,
  "physical_mac" : "aeiou",
  "type_full" : "aeiou",
  "id" : "",
  "pwd" : "aeiou",
  "type" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список виртуальных серверов

0

Общая ошибка от сервера String
Up 
get /vds/reboot
Перезагрузка VDS (vdsRebootGet)
Предоставляет функционал для перезагрузки VDS

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID виртуального сервера, полученный из /vds/list

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Возврат строки 'OK' означает успех операции String

0

Общая ошибка от сервера String
Up 
get /vds/templates-list
Список шаблонов виртуальных серверов (vdsTemplatesListGet)
Позволяет получить список шаблонов виртуальных серверов

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации

Return type

array[inline_response_200_13]

Example data

Content-Type: application/json
[ {
  "template" : "aeiou",
  "actual_template" : "",
  "popularity" : "",
  "type" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Список шаблонов виртуальных серверов

0

Общая ошибка от сервера String
Up 
get /vds/update
Создание VDS (vdsUpdateGet)
Создание новых VDS с произвольными характеристиками

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

_token_ (required)
Query Parameter — Ключ доступа, полученный при авторизации
_key_ (required)
Query Parameter — ID виртуального сервера, полученный из /vds/list
cr_hvmem (optional)
Query Parameter — Количество доступной памяти в мегабайтах. По умолчанию 2048
cr_hvdsk (optional)
Query Parameter — Количество доступных гигабайт диска. По умолчанию 30
cr_hvcpu (optional)
Query Parameter — Количество ядер CPU. По умолчанию 2

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Параметры VDS успешно обновлены String

0

Общая ошибка от сервера String
Up

Models

[ Jump to Methods ]

Table of Contents

  2. inline_response_200
  3. inline_response_200_1
  4. inline_response_200_10
  5. inline_response_200_11
  6. inline_response_200_12
  7. inline_response_200_13
  8. inline_response_200_14
  9. inline_response_200_2
  10. inline_response_200_3
  11. inline_response_200_4
  12. inline_response_200_5
  13. inline_response_200_6
  14. inline_response_200_7
  15. inline_response_200_8
  16. inline_response_200_9

Up

mail
String Ограничение на количество почтовых ящиков. '-' означает отсутствие лимита.
website
String Ограничение на количество сайтов. '-' означает отсутствие лимита.
mysql
Boolean MySQL разрешен, если true.
size
String Ограничение на размер дискового пространства. '-' означает отсутствие лимита.
mssql
Boolean MSSQL разрешен, если true.
dynamic_content
Boolean CGI и PHP скрипты разрешены, если true.
php_exec
Boolean Функция exec() в PHP разрешена, если true.
ftp2
String Ограничение на количество дополнительных FTP логинов. '-' означает отсутствие лимита.

inline_response_200 Up

negative_balance_days
Integer Планируемое количество дней до наступления негативного баланса
negative_balance_days_lic
Integer Планируемое количество дней до наступления негативного баланса по аккаунту лицензий
last_month_debt_sum
BigDecimal
last_month_debt_sum2
BigDecimal
block_date
String Дата блокировки аккаунта

inline_response_200_1 Up

id
Integer Идентификатор аккаунта
description
String Описание аккаунта
billing_group_id
Integer Идентификатор тарифной группы
blocked
String Аккаунт заблокирован, если true
blocked_date (optional)
String Дата блокировки
blocked_reason (optional)
String Причина блокировки
credit_limit
BigDecimal Ограничение суммы на работу в аванс
plan_id
Integer Идентификатор тарифа
period_id
Integer Идентификатор тарифа (периода)
contract_type
Integer Тип договора
client_id
Integer
client_login
String Логин клиента
contract_id
String Номер договора
name_rus
String Имя клиента на русском
name_eng
String Имя клиента на английском
email
String E-mail клиент
stat_sites
Integer Количество созданных сайтов
stat_size_mb
Integer Используемое дисковое пространство
stat_emails
Integer Количество созданных почтовых ящиков
stat_mysqls
Integer Количество баз данных MySQL
stat_tech
Integer
stat_nicd
Integer
stat_access_dynamic
Integer
stat_access_static
Integer
stat_access_traffic
Integer
stat_paid_total
Integer
stat_vds_size
Integer Размер дисков VDS
__plan_name
String Название тарифного плана
__period_months
Integer Количество месяцев в оплаченном периоде
__period_price
BigDecimal Стоимость оплаченного периода
__expires
String
external_currency_spelled_prefix
String Префикс для вывода текущей валюты хостинга (например, в строке '$100' префиксом является '$')
external_currency_spelled_suffix
String Суффикс для вывода текущей валюты хостинга (например, в строке '100 руб.' суффиксом является ' руб.'

inline_response_200_10 Up

id
Integer Идентификатор записи
datetime
String Дата и время создания записи
description
String Тело сообщения (с HTML-тэгами)
description_plain
String Тело сообщения (без тэгов)

inline_response_200_11 Up

ip
String IP-адрес
vds_id
Integer идентификатор VDS

inline_response_200_12 Up

id
Integer идентификатор VDS
deleted
Boolean VDS удалён если true
online
Boolean VDS работает нормально если true
stopped
Boolean VDS остановлен если true
pwd
String изначальный пароль администратора или root
template
String шаблон, на основе которого был создан VDS
type_full
String полное описание типа VDS
physical_mac
String MAC-адрес VDS
type
String тип VDS

inline_response_200_13 Up

type
String Тип VDS, для которого применим шаблон. Принимает значения 'hv' и 'vz'
template
String Имя шаблона
popularity
Integer Популярность
actual_template
Integer Актуальность шаблона. 1 = шаблон актуален

inline_response_200_14 Up

id
Integer
status
String
unmovable
String
online
String Включен (активен), если true.
deleted
String Удален, если true. Данные могут сохраняться.
deleted_auto
String Удален, если true. Данные могут сохраняться.
deleted_dump
String
user_id
String
ftp_id
String
dns_id
String
iis_id
String
iis_binding
String
iis_path
String
iis_comments
String Уникальное строковое имя сайта (ID).
memo
String
date_reg
String Дата создания.
server
String Тип веб-сервера.
server_bak
String
server_aux
String
server_transition
String Тип сервера недавно изменялся, если true.
server_transition_dtc
String
block_transfer
String
server_changed_time
String
size_amount
String Размер веб-сайта - объем (Кб).
size_file_count
String Размер веб-сайта - кол-во файлов.
size_file_count_limit
String
size_date
String Размер веб-сайта - дата замера.
size_priority_scan
String
copy_logs
String
content_comments
String
content_comments_verbose
String
meta_save_count
String
base_folder
String
virtualhost_conf
String
virtualhost_server
String
virtualhost_server_conf
String
live_day_count
String
scan_date
String
global_transfer_count
String
net_limit_file
String
net_limit_deny_from_ip
String
net_limit_deny_from_agent
String
apache_php_pooled
String
apache_php_pooled_ext
String
apache_php_pooled_ext_auto
String
apache_php_pool1_only
String
apache_php_pool5_only
String
apache_ssi
String
bypass_security
String
flag_generic_exec
String
flag_no_www
String
base_folder_suffix
String
feedback_speed
String
feedback_speed_dtc
String
feedback_speed_feedback
String
unix_path_on_windows
String
ftp_ipfilter
String Ограничение по IP адресам - FTP доступ.
ssh_ipfilter
String Ограничение по IP адресам - SSH доступ.
l3d_auto
String
awstats_primary_domain
String
sharepoint_mode
String
sharepoint_mode_pending
String
apache_generic_pool_port
String
mongrel_environment
String
flag_free
String
rtm_scan_date
String
analyze_analog
String
cpu_details_enabled
String Включен режим предоставления детализации процессорной нагрузки.
content_moderated_status
String
content_moderated_date
String
http_frontend_ip
String
http_frontend_ip_transition
String
cpu_limit_exceeded_date
String Дата последнего превышения процессорной нагрузки.
aufs_template
String Признак сайта-конструктора.
options_autolimit
String
iis_creation_commands
String Версия ASP.NET, если отлична от 2.0.
iis_creation_commands_unix
String
thumb_date
String
thumb_failed
String
backup_stat_date
String
backup_date
String Дата пофайловой резервной копии.
detected_packages
String
stat_site_power
String
smtp_from
String
super_backup_date
String
backup_delta_stat_date
String
backup_delta_date
String Дата архивной резервной копии.
backup_delta_desc
String Содержимое архивной резервной копии.
alt_docroot_server
String
alt_docroot_path
String
alt_docroot_status
String
alt_docroot_status_cnt
String
alt_docroot_status_date
String
bind_dtc
String Последнее изменение привязок доменов для сайта.
backup_special_mode
String
size_check_problem
String
wpb_domain
String
wpb_uuid
String Для сайта включен конструктор Parallels WPB.
wpb_status
String
admin_protection
String
size_comments
String
alt_docroot_ssd_req
String
mail_limit
String
mail_accept
String
mail_drop
String
ftp_name
String FTP/SSH/SCP/SFTP логин.
ftp_pwd
String FTP/SSH/SCP/SFTP пароль.

inline_response_200_2 Up

id
Integer идентификатор аккаунта
name
String логин
server
String идентификатор сервера. Если равен или больше 10000, то это Postgres. Иначе MySQL
pwd
String пароль
url_suffix
String суффикс домена сервера

inline_response_200_3 Up

id
Integer идентификатор домена
iis_id
Integer идентификатор связанной записи IIS
online
Boolean домен работает, если true
full_domain_name
String полное имя домена
full_domain_name_local
String
addr1
String
zone
String зона домена

inline_response_200_4 Up

date_updated
String Дата последнего обновления домена
record_created
String Дата создания записи
subject_contract
String
end_date
String
payed_till
String Дата, до которой оплачен домен
object_state
String
domain_addr
String Имя домена
nservers
String Сервера имён домена
expires_countdown
Integer Количество дней до окончания срока действия домена

inline_response_200_5 Up

id
Integer идентификатор псевдонима
mail
String почтовый ящик псевдонима
alias
String имя псевдонима

inline_response_200_6 Up

id
Integer идентификатор ящика
status
Integer
online
Boolean ящик работает, если true
mail
String полный адрес ящика
mercury_user
String имя пользователя для входа в Mercury
mercury_pwd
String пароль для входа в Mercury
size_amount
Integer текущий размер ящика
size_file_count
Integer количество файлов, занятых ящиком
archived_count
Integer
server_pop3
String адрес сервера для доступа к ящику по POP3
server_smtp
String адрес сервера для доступа к ящику по SMTP
server_webmail
String адрес сервера Webmail для входа в ящик через браузер
server_imap
String адрес сервера для доступа к ящику по IMAP
wm1
String
wm2
String

inline_response_200_7 Up

id
Integer идентификатор аккаунта
name
String логин
pwd
String пароль

inline_response_200_8 Up

id
Integer идентификатор сайта
online
Boolean сайт работает нормально если true
ftp_id
Integer идентификатор связанного аккаунта FTP
dns_id
Integer идентификатор связанной записи DNS
size_amount
Integer размер занятого места
size_file_count
Integer количество файлов
size_file_count_limit
Integer ограничение на количество файлов

inline_response_200_9 Up

id
Integer идентификатор аккаунта
db
String имя базы данных
server
String адрес сервера
name
String логин
pwd
String пароль