pdns.php¶

Модуль управления DNS-записями, доменами и поддоменами: добавление, редактирование и удаление записей, доменов и поддоменов

Методы API¶

Метод	Действие	Описание
`add_dns`	добавление DNS-записи	Добавляет новую DNS-запись в зону. Параметры записи передаются через массив dns.
`add_domain`	добавление домена	Регистрация нового домена в системе.
`add_subdomain`	добавление поддомена	Создает новый поддомен.
`delete_dns`	удаление DNS-записи	Удаляет существующую DNS-запись.
`delete_domain`	удаление домена	Удаляет домен из системы.
`delete_subdomain`	удаление поддомена	Удаляет поддомен.
`edit_subdomain`	редактирование поддомена	Изменяет параметры существующего поддомена.
`get_cb_url`	получение URL для callback	Возвращает URL для отправки уведомлений (callback) системы DNS.
`get_domain_info`	получение информации о домене	Возвращает детальную информацию о конкретном домене (доступно только администраторам).
`list_domains`	получение списка доменов	Возвращает список всех доменов, принадлежащих текущему клиенту.
`list_subdomains`	получение списка поддоменов	Возвращает список поддоменов для текущего клиента или администратора.
`list_zones`	получение списка зон	Возвращает список DNS-зон.
`view_zone`	просмотр зоны	Возвращает содержимое DNS-зоны.

pdns/add_dns¶

Добавляет новую DNS-запись в зону. Параметры записи передаются через массив dns.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_dns`
token	✅	string	Токен авторизации
dns[ttl]	❌	integer	Время жизни записи (TTL).
dns[mname]	❌	string	Master name. Допустимые значения: формат FQDN.
dns[rname]	❌	string	Resource name. Допустимые значения: формат FQDN.
dns[serial]	❌	integer	Серийный номер зоны.
dns[refresh]	❌	integer	Интервал обновления (Refresh).
dns[retry]	❌	integer	Интервал повтора (Retry).
dns[expire]	❌	integer	Время истечения (Expire).
dns[minimum]	❌	integer	Минимальный TTL.
dns[content]	❌	string	Содержимое записи (IP, CNAME и т.д.).

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=add_dns" \
--data "token=YOUR_TOKEN" \
--data "dns[ttl]=3600" \
--data "dns[content]=1.2.3.4"

Пример успешного ответа

{
"result": "OK",
"action": "add_dns",
"data": {
"id": 12345,
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "invalid input argument dns.content"
}

pdns/delete_dns¶

Удаляет существующую DNS-запись.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_dns`
token	✅	string	Токен авторизации
id	✅	integer	ID записи для удаления.

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=delete_dns" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

Пример успешного ответа

{
"result": "OK",
"action": "delete_dns",
"data": {
"id": 12345,
"status": "deleted"
}
}

Примеры ошибок

{
"code": -1,
"message": "Record not found"
}

pdns/add_domain¶

Регистрация нового домена в системе.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_domain`
token	✅	string	Токен авторизации
name	✅	string	Имя домена. Допустимые значения: формат FQDN.

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=add_domain" \
--data "token=HOSTKEY_TOKEN" \
--data "name=example.com"

Пример успешного ответа

{
"result": "OK",
"action": "add_domain",
"data": {
"id": 567,
"name": "example.com",
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Domain already exists"
}

pdns/delete_domain¶

Удаляет домен из системы.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_domain`
token	✅	string	Токен авторизации
name	✅	string	Имя домена для удаления. Допустимые значения: формат FQDN.
customer_id	✅	integer	Параметр `customer_id`

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=delete_domain" \
--data "token=HOSTKEY_TOKEN" \
--data "name=example.com" \
--data "customer_id=123"

Пример успешного ответа

{
"result": "OK",
"action": "delete_domain",
"data": {
"id": 567,
"status": "deleted"
}
}

Примеры ошибок

{
"code": -1,
"message": "Domain not found"
}

pdns/add_subdomain¶

Создает новый поддомен.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_subdomain`
token	✅	string	Токен авторизации
name	✅	string	Имя поддомена. Допустимые значения: формат FQDN.

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=add_subdomain" \
--data "token=HOSTKEY_TOKEN" \
--data "name=sub.example.com"

Пример успешного ответа

{
"result": "OK",
"action": "add_subdomain",
"data": {
"id": 888,
"name": "sub.example.com",
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Subdomain creation failed"
}

pdns/edit_subdomain¶

Изменяет параметры существующего поддомена.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `edit_subdomain`
token	✅	string	Токен авторизации
name	✅	string	Имя поддомена. Допустимые значения: формат FQDN.

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=edit_subdomain" \
--data "token=HOSTKEY_TOKEN" \
--data "name=sub.example.com"

Пример успешного ответа

{
"result": "OK",
"action": "edit_subdomain",
"data": {
"id": 888,
"name": "sub.example.com",
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Subdomain not found"
}

pdns/delete_subdomain¶

Удаляет поддомен.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_subdomain`
token	✅	string	Токен авторизации
name	✅	string	Имя поддомена. Допустимые значения: формат FQDN.

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=delete_subdomain" \
--data "token=HOSTKEY_TOKEN" \
--data "name=example.com"

Пример успешного ответа

{
"result": "OK",
"action": "delete_subdomain",
"data": {
"id": 888,
"status": "deleted"
}
}

Примеры ошибок

{
"code": -1,
"message": "Subdomain not found"
}

pdns/get_cb_url¶

Возвращает URL для отправки уведомлений (callback) системы DNS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_cb_url`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=get_cb_url" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_cb_url",
"data": {
"callback_url": "https://dns.example.com/callback/7bc29eb23fb1b879b21fce509597f07c"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

pdns/get_domain_info¶

Возвращает детальную информацию о конкретном домене (доступно только администраторам).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_domain_info`
token	✅	string	Токен авторизации
customer_id	✅	integer	ID клиента (используется администратором)
id	✅	integer	ID домена для получения информации

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=get_domain_info" \
--data "token=HOSTKEY_TOKEN" \
--data "customer_id=VALUE" \
--data "id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "get_domain_info",
"data": {
"id": 123,
"name": "example.com",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Not enought actual parameters"
}

pdns/list_domains¶

Возвращает список всех доменов, принадлежащих текущему клиенту.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_domains`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=list_domains" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list_domains",
"data": [
{
"id": 1,
"name": "example.com",
"status": "active"
},
{
"id": 2,
"name": "test.net",
"status": "pending"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

pdns/list_subdomains¶

Возвращает список поддоменов для текущего клиента или администратора.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_subdomains`
token	✅	string	Токен авторизации
customer_id	✅	integer	Идентификатор клиента для получения списка поддоменов

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=list_subdomains" \
--data "token=HOSTKEY_TOKEN" \
--data "customer_id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "list_subdomains",
"data": [
{
"id": 10,
"name": "sub.example.com",
"parent_domain": "example.com"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

pdns/list_zones¶

Возвращает список DNS-зон.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list_zones`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=list_zones" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list_zones",
"data": [
{
"id": 5,
"name": "example.com",
"type": "master"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

pdns/view_zone¶

Возвращает содержимое DNS-зоны.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `view_zone`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/pdns.php" -X POST \
--data "action=view_zone" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "view_zone",
"data": {
"name": "example.com",
"records": [
{
"type": "A",
"content": "1.2.3.4",
"ttl": 3600
}
]
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}