ipv4rs.php¶

В этой статье

Методы API

ipv4rs/add

ipv4rs/update

ipv4rs/show

ipv4rs/list

ipv4rs/delete

API модуль управления IPv4 ресурсами: добавление, обновление, удаление и просмотр записей в базе данных

Методы API¶

Метод	Действие	Описание
`add`	создание записи	Создает новую запись IPv4 ресурса, привязанную к владельцу (email администратора).
`delete`	удаление записи	Удаляет запись IPv4 ресурса по её ID.
`list`	получение списка	Возвращает список всех запи项 IPv4 ресурсов.
`show`	просмотр записи	Возвращает детальную информацию о конкретной записи IPv4 ресурса по её ID.
`update`	обновление записи	Обновляет существующую запись IPv4 ресурса по её ID.

ipv4rs/add¶

Создает новую запись IPv4 ресурса, привязанную к владельцу (email администратора).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
params[network]	✅	string	Сетевой адрес (IPv4)
params[broadcast]	✅	string	Адрес широковещательной рассылки (IPv4)
params[rz_id]	✅	string	Идентификатор зоны регистрации
params[hidden]	❌	integer	Флаг скрытия записи (0 или 1)
params[groups]	✅	string	Группы для привязки записи
params[pdns_loc]	❌	string	Локация в DNS (PowerDNS location): RU, COM

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

curl -s "https://invapi.hostkey.ru/ipv4rs.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[network]=1.2.3.0" \
--data "params[broadcast]=1.2.3.255" \
--data "params[rz_id]=5" \
--data "params[groups]=some_group"

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

{
"result": "OK",
"module": "ipv4rs",
"action": "add",
"data": {
"id": 1,
"network": "1.2.3.0",
"broadcast": "1.2.3.255",
"rz_id": 5,
"hidden": 0,
"groups": "some_group"
}
}

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

{
"errors": [
{
"code": -1,
"message": "Action required"
},
{
"code": -1,
"message": "Network cannot be empty"
},
{
"code": -1,
"message": "Broadcast cannot be empty"
},
{
"code": -1,
"message": "Location must be given"
},
{
"code": -1,
"message": "Groups must be given"
},
{
"code": -1,
"message": "Duplicate entry on network, broadcast and location"
},
{
"code": -1,
"message": "Action is not recognized"
}
]
}

ipv4rs/update¶

Обновляет существующую запись IPv4 ресурса по её ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
params[rz_id]	✅	integer	ID связанной зоны (reg_zone_fk_id)
params[hidden]	❌	boolean	Флаг скрытия записи (1 - скрыта, 0 - видна)
params[groups]	✅	string	Идентификатор группы записей

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

curl -s "https://invapi.hostkey.ru/ipv4rs.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "params[rz_id]=1" \
--data "params[groups]=VALUE"

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

{
"result": "OK",
"module": "ipv4rs",
"action": "update",
"data": {
"id": 1,
"network": "...",
"broadcast": "...",
"reg_zone_fk_id": 1,
"IsHidden": 0,
"Groups": "..."
}
}

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

{
"OutOfBoundsException": {
"code": -1,
"message": "Invalid ID [id]"
},
"RuntimeException": {
"code": -1,
"message": "Duplicate entry on network, broadcast and location"
}
}

ipv4rs/show¶

Возвращает детальную информацию о конкретной записи IPv4 ресурса по её ID.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/ipv4rs.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "ipv4rs",
"action": "show",
"data": {
"id": 123,
"network": "1.2.3.0",
"broadcast": "1.2.3.4",
"rz_id": 5,
"hidden": 0,
"groups": null
}
}

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

{
"PlatformException": [
{
"code": -1,
"message": "Action required"
},
{
"code": -1,
"message": "Action is not recognized"
}
],
"RangeException": [
{
"code": -1,
"message": "ipv4r {id} not found"
}
]
}

ipv4rs/list¶

Возвращает список всех запи项 IPv4 ресурсов.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "ipv4rs",
"action": "list",
"data": [
{
"id": 1,
"network": "1.2.3.4",
"broadcast": "1.2.3.5",
"rz_id": 10,
"hidden": false,
"groups": null
}
]
}

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

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

ipv4rs/delete¶

Удаляет запись IPv4 ресурса по её ID.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/ipv4rs.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

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

{
"result": "OK",
"module": "ipv4rs",
"action": "delete",
"data": {
"id": 123
}
}

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

{
"code": -1,
"message": "Invalid range_ip 0"
}