vlans.php¶

В этой статье

Методы API

vlans/add

vlans/add_history

vlans/delete

vlans/history

vlans/list

vlans/show

vlans/update

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

Методы API¶

Метод	Действие	Описание
`add`	создание vlan	Создает новый VLAN в системе.
`add_history`	добавление записи в историю	Добавляет запись о событии в историю изменений VLAN.
`delete`	удаление vlan	Удаляет существующий VLAN.
`history`	получение истории изменений	Возвращает список записей истории для указанного VLAN.
`list`	получение списка vlan	Возвращает список всех VLAN с возможностью фильтрации.
`show`	просмотр vlan	Возвращает детальную информацию о конкретном VLAN.
`update`	обновление vlan	Обновляет параметры существующего VLAN.

vlans/add¶

Создает новый VLAN в системе.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "add",
"data": {
"id": 101,
"number": 100,
"name": "Management VLAN",
"status": "active"
}
}

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

{
"code": -1,
"message": "Invalid parameters"
}

vlans/add_history¶

Добавляет запись о событии в историю изменений VLAN.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `add_history`
token	✅	string	Токен авторизации
id	✅	integer	ID VLAN
message	✅	string	Текст сообщения для истории

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

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

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

{
"history": [
{
"id": 5001,
"entity_type": "vlan",
"entity_id": 101,
"message": "VLAN created manually",
"created_at": "2024-05-20T12:00:00Z"
}
]
}

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

{
"code": 400,
"message": "Please provide VLAN ID"
}

vlans/delete¶

Удаляет существующий VLAN.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "delete",
"data": {
"status": "deleted"
}
}

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

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

vlans/history¶

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

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history`
token	✅	string	Токен авторизации
id	✅	integer	ID VLAN
type	❌	`array<string>`	Фильтр по типу события. Принимает несколько значений: type[]=val1&type[]=val2
date_from	❌	string	Дата начала истории (ISO-формат)

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

curl -s "https://invapi.hostkey.ru/vlans.php" -X GET \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "type[]=val1" \
--data "type[]=val2"

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

{
"result": "OK",
"action": "history",
"history": [
{
"id": 5001,
"type": "note",
"message": "VLAN updated",
"created_at": "2024-05-20T10:30:00Z"
}
]
}

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

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

vlans/list¶

Возвращает список всех VLAN с возможностью фильтрации.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
number	❌	integer	Номер VLAN (VLAN ID)
location	❌	string	Фильтр по локации

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

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

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

{
"result": "OK",
"action": "list",
"data": [
{
"id": 10,
"number": 10,
"name": "Default VLAN",
"location": "NL"
}
]
}

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

{
"code": -1,
"message": "Error fetching list"
}

vlans/show¶

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

HTTP-метод: GET

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/vlans.php" -X GET \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=10"

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

{
"result": "OK",
"action": "show",
"data": {
"id": 10,
"number": 10,
"name": "Management VLAN",
"status": "active",
"location": "DE"
}
}

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

{
"code": -404,
"message": "VLAN not found"
}

vlans/update¶

Обновляет параметры существующего VLAN.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/vlans.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=10"

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

{
"result": "OK",
"action": "update",
"data": {
"id": 10,
"name": "Updated Name"
}
}

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

{
"code": -1,
"message": "Update failed"
}