ipmip.php¶

В этой статье

Методы API

ipmip/add

ipmip/delete

ipmip/list

ipmip/show

API модуль управления IP-адресами: добавление, удаление, просмотр и получение списка доступных адресов

Методы API¶

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

ipmip/add¶

Создает новую запись IP-адреса в системе.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
params[location_id]	✅	integer	Идентификатор местоположения (Location ID)
params[ip]	✅	string	IP-адрес устройства

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

curl -s "https://invapi.hostkey.ru/ipmip.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[location_id]=5" \
--data "params[ip]=192.168.1.1"

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

{
"result": "OK",
"module": "ipmip",
"action": "add",
"data": {
"ID": 1,
"Location_ID": 5,
"Ip": "192.168.1.1"
}
}

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

{
"code": -1,
"message": "Location ID cannot be empty"
}

ipmip/delete¶

Удаляет существующую запись IP-адреса по её ID.

HTTP-метод: POST

Параметры:

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

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

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

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

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

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

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

ipmip/list¶

Возвращает список IP-адресов, отфильтрованных по локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
location_id	❌	integer	ID локации для фильтрации. Должен быть больше 0.

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

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

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

{
"result": "OK",
"module": "ipmip",
"action": "list",
"data": [
{
"id": 1,
"ip": "1.1.1.1",
"location_id": 5
},
{
"id": 2,
"ip": "1.1.1.2",
"location_id": 5
}
]
}

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

{
"OutOfBoundsException": {
"code": -1,
"message": "Invalid Location ID [value]"
},
"PlatformException": {
"code": -1,
"message": "Action is not recognized"
}
}

ipmip/show¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "ipmip",
"action": "show",
"data": {
"ID": 123,
"IP": "192.168.1.1",
"ROLE_NAME": "example"
}
}

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

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