locations.php¶

В этой статье

Методы API

locations/add

locations/add_tag

locations/clone

locations/delete

locations/delete_tag

locations/get

locations/history

locations/list

locations/list_tags

locations/show

locations/update

locations/update_tag

API модуль управления локациями и тегами: получение списка доступных регионов, детальная информация о локации, управление тегами и история изменений.

Методы API¶

Метод	Действие	Описание
`add`	создание новой локации	Создает новую локацию и возвращает объект созданной сущности.
`add_tag`	добавление тега	Добавляет новый тег к локации.
`clone`	клонирование локации	Создает копию существующей локации.
`delete`	удаление локации	Удаляет локацию из системы.
`delete_tag`	удаление тега	Удаляет существующий тег.
`get`	получение локации	Получает детальную информацию о конкретной локации по ID или коду.
`history`	получение истории	Возвращает историю изменений для локации.
`list`	список локаций	Возвращает список всех доступных локаций.
`list_tags`	список тегов	Возвращает список всех доступных тегов.
`show`	получение информации о локации	Возвращает детальную информацию о локации по её ID.
`update`	обновление локации	Обновляет данные существующей локации по её ID.
`update_tag`	обновление тега локации	Обновляет существующий тег локации.

locations/add¶

Создает новую локацию и возвращает объект созданной сущности.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
params[name]	✅	string	Название локации.
params[code]	❌	string	Код локации (например, NL).
params[status]	❌	string	Статус локации.
params[description]	❌	string	Описание локации.
params[city]	❌	string	Город локации.

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

curl -s "https://invapi.hostkey.ru/locations.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[name]=Amsterdam" \
--data "params[code]=NL" \
--data "params[status]=active" \
--data "params[description]=Main datacenter" \
--data "params[city]=Amsterdam"

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

{
"result": "OK",
"module": "locations",
"action": "add",
"data": {
"ID": 123,
"Reg_zoneID": 5,
"Name": "Amsterdam",
"Code": "NL",
"status": "active",
"description": "Main datacenter"
}
}

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

{
"-1": [
{
"message": "invalid argument name ''"
},
{
"message": "Action is not recognized"
}
]
}

locations/add_tag¶

Добавляет новый тег к локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_tag`
token	✅	string	Токен авторизации
tag	✅	string	Значение тега
value	❌	string	Дополнительное значение тега
extra	❌	string	Дополнительная информация для тега
location_id	✅	integer	Идентификатор локации
internal	❌	boolean	Флаг внутреннего тега (1 — внутренний, 0 — внешний)

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

curl -s "https://invapi.hostkey.ru/locations.php" -X POST \
--data "action=add_tag" \
--data "token=YOUR_TOKEN" \
--data "tag=my_tag" \
--data "location_id=123"

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

{
"id": 1
}

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

{
"code": -1,
"message": "invalid argument tag ''"
}

locations/clone¶

Создает копию существующей локации.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "clone",
"data": {
"id": 123,
"Name": "New York City Updated",
"Code": "-",
"description": "Data center in New York",
"status": "active"
}
}

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

{
"code": -1,
"message": "invalid argument id '0'"
}

locations/delete¶

Удаляет локацию из системы.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"module": "locations",
"action": "delete",
"data": {
"ID": 123
}
}

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

{
"code": -1,
"message": "invalid argument id '...'"
}

locations/delete_tag¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/locations.php" -X POST \
--data "action=delete_tag" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12" \
--data "location_id=LOC_ID"

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

{
"result": "OK",
"action": "delete_tag",
"data": {
"id": 12
}
}

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

{
"code": -1,
"message": "invalid argument id '...'"
}

locations/get¶

Получает детальную информацию о конкретной локации по ID или коду.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get`
token	✅	string	Токен авторизации
id	❌	integer	string
location	❌	string	Alpha2 код локации (например: US, DE, NL)

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

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

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

{
"id": 10,
"Code": "DE",
"Name": "Frankfurt",
"description": "Описание локации",
"status": "active",
"Reg_zoneID": 5
}

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

{
"code": -1,
"message": "Location loc:{id} does not exist"
}

locations/history¶

Возвращает историю изменений для локации.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "history",
"data": [
{
"id": 1,
"date": "2023-10-27 10:00:00",
"description": "Описание изменения (может содержать JSON данные)",
"type": "string",
"login": "admin"
}
]
}

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

{
"code": -1,
"message": "invalid argument id '...'"
}

locations/list¶

Возвращает список всех доступных локаций.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list",
"locations": [
{
"id": 1,
"Code": "AMS",
"Name": "Amsterdam",
"description": "Description of Amsterdam",
"status": "active",
"Reg_zoneID": 5,
"tags": []
}
]
}

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

{
"code": -1,
"message": "Action is not recognized"
}

locations/list_tags¶

Возвращает список всех доступных тегов.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list_tags",
"data": [
{
"tag": "string",
"id": "integer",
"internal": "boolean",
"location_id": "integer"
}
]
}

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

{
"code": -1,
"message": "invalid argument location_id '...'"
}

locations/show¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "show",
"data": {
"id": 123,
"name": "Amsterdam",
"code": "NL",
"tags": [
{
"id": 5,
"name": "high-speed"
}
]
}
}

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

{
"code": -1,
"message": "Action is not recognized"
}

locations/update¶

Обновляет данные существующей локации по её ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
params[id]	✅	integer	ID локации для обновления.
params[name]	✅	string	Название локации.
params[code]	❌	string	Код локации.
params[status]	❌	string	Статус локации.
params[description]	❌	string	Описание локации (обновляется в reg_zone).
params[city]	❌	string	Город локации (сохраняется как тег city).

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

curl -s "https://invapi.hostkey.ru/locations.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=123" \
--data "params[name]=New Location Name" \
--data "params[code]=DE" \
--data "params[status]=active" \
--data "params[description]=Updated description" \
--data "params[city]=Frankfurt"

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

{
"result": "OK",
"module": "locations",
"action": "update",
"data": {
"ID": 123,
"Reg_zoneID": 5,
"Name": "Frankfurt Central",
"Code": "DE",
"status": "active",
"description": "Updated description",
"tags": []
}
}

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

{
"-1": [
"Action required",
"invalid argument id '0'",
"location:X not found",
"Missing required keys: name"
]
}

locations/update_tag¶

Обновляет существующий тег локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_tag`
token	✅	string	Токен авторизации
params[id]	✅	integer	ID тега.
params[tag]	✅	string	Название (текст) тега.
params[location_id]	✅	number	ID локации, к которой относится тег.
params[value]	❌	string	Дополнительное значение тега.
params[extra]	❌	string	Дополнительная информация для тега.
params[internal]	❌	boolean	Флаг внутреннего тега (1 — внутренний, 0 — обычный).

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

curl -s "https://invapi.hostkey.ru/locations.php" -X POST \
--data "action=update_tag" \
--data "token=HOSTKEY_TOKEN" \
--data "params[id]=10" \
--data "params[tag]=my_tag" \
--data "params[location_id]=5"

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

{
"result": "OK",
"action": "update_tag",
"data": {
"id": 10
}
}

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

{
"code": -1,
"message": "invalid argument id '...'"
}