ip.php¶

Модуль управления IP-адресами и сетевой инфраструктурой: получение информации об IP, управление PTR-записями, отслеживание трафика, работа с подсетями и VLAN.

Методы API¶

Метод	Действие	Описание
`get_client_ip`	получение клиентского IP	Возвращает текущий IP-адрес клиента, совершившего запрос к API.
`get_ip`	получение информации об IP	Возвращает полную информацию о сетевых настройках конкретного IP-адреса (маска, сеть и т.д.)
`get_ptr`	получение PTR записи	Проверяет, принадлежит ли IP-адрес серверу, и возвращает текущую PTR запись для данного IP в указанной локации.
`get_traffic`	получение трафика	Возвращает данные о входящем и исходящем трафике для указанного IP-адреса за выбранный период. Может возвращать как сводную информацию (summary), так и детальные временные метки.
`list_free_ip`	получение списка свободных IP	Возвращает список неиспользуемых IPv4 адресов для указанной локации на основе тегов Route Reflector. Для клиентов доступно только в рамках их собственных подсетей.
`set_main`	установка основного IP	Устанавливает указанный IP-адрес как основной для сетевого интерфейса сервера.
`update_ptr`	обновление PTR-записи	Обновляет обратную DNS-запись (PTR) для указанного IP-адреса в рамках конкретной локации. Требуется проверка прав доступа к серверу.

ip/get_client_ip¶

Возвращает текущий IP-адрес клиента, совершившего запрос к API.

HTTP-метод: GET|POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/ip.php" -X GET|POST \
--data "action=get_client_ip" \
--data "token=HOSTKEY_TOKEN"

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

{
"ip": "192.168.1.1"
}

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

``` { "code": -1, "message": "authentication required" }

```

ip/get_ip¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "ip",
"action": "get_ip",
"data": {
"network": "192.168.1.0",
"netmask": "255.255.255.0",
"gateway": "192.168.1.1"
}
}

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

``` { "code": -1, "message": "malformed IP=127.0.0.1 for token 12345" }

```

ip/get_ptr¶

Проверяет, принадлежит ли IP-адрес серверу, и возвращает текущую PTR запись для данного IP в указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
token	✅	string	Токен авторизации
ip	✅	string	IP-адрес
id	✅	int	ID сервера
location	❌	string	Локация

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

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

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

{
"result": "OK",
"message": "example.domain.com"
}

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

``` { "code": -1, "message": "invalid IP" }

```

ip/get_traffic¶

Возвращает данные о входящем и исходящем трафике для указанного IP-адреса за выбранный период. Может возвращать как сводную информацию (summary), так и детальные временные метки.

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_traffic`
token	✅	string	Authentication token
ip	✅	string	IP address to report traffic for
period_start	❌	int	Start timestamp (default: current_time - 86400)
period_stop	❌	int	End timestamp (default: current_time)
summary	❌	int	1 - return only summary (in/out in GB), 0 - all ticks with timestamps
unbilled	❌	int	1 - return only unbilled ticks, 0 - all ticks

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

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

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

{
"result": "OK",
"traffic": [
{
"timestamp": "2024-05-20T12:00:00Z",
"in": 1.25,
"out": 0.85
}
]
}

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

``` { "code": -1, "message": "no significant traffic detected for [ip] in the period [date] - [date]" }

```

ip/list_free_ip¶

Возвращает список неиспользуемых IPv4 адресов для указанной локации на основе тегов Route Reflector. Для клиентов доступно только в рамках их собственных подсетей.

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Имя действия (list_free_ip)
token	✅	string	Токен авторизации
exclude_special	❌	int	Исключить специальные адреса (0 или 1)
location	✅	string	Локация для поиска свободных IP

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

curl -s "https://invapi.hostkey.ru/ip.php" -X POST \
--data "action=list_free_ip" \
--data "token=HOSTKEY_TOKEN" \
--data "location=VALUE"

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

{
"result": "OK",
"ip": [
"192.168.1.1",
"10.0.0.5"
]
}

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

``` { "code": -1, "message": "illegal IP subnet" }

```

ip/set_main¶

Устанавливает указанный IP-адрес как основной для сетевого интерфейса сервера.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
token	✅	string	Authentication token
id	✅	int	Server ID
ip	✅	string	IP address to set as main
main	❌	int	Main flag (0 for IPMI or 1 for IPv4)
description	❌	string	Description for the IP

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

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

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

{
"result": "OK",
"message": "Data from m_capsule (ipv4_set_main result)"
}

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

``` { "code": -1, "message": "invalid request (id missing or IP not assigned for server)" }

```

ip/update_ptr¶

Обновляет обратную DNS-запись (PTR) для указанного IP-адреса в рамках конкретной локации. Требуется проверка прав доступа к серверу.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Имя действия (`update_ptr`)
token	✅	string	Токен авторизации
id	✅	int	ID сервера
ip	✅	string	IP-адрес
ptr	✅	string	Значение PTR-записи
location	❌	string	Локация

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

curl -s "https://invapi.hostkey.ru/ip.php" -X POST \
--data "action=update_ptr" \
--data "token=YOUR_TOKEN" \
--data "id=123" \
--data "ip=1.2.3.4" \
--data "ptr=example.com"

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

{
"result": "OK",
"message": ""
}

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

``` { "code": -1, "message": "IP 1.2.3.4 is not assigned for server 5" }

```