projects.php¶

Модуль управления проектами: создание, редактирование, удаление и назначение серверов в проекты

Методы API¶

Метод	Действие	Описание
`add`	создание проекта	Создает новый проект с указанным именем.
`assign`	назначение сервера в проект	Назначает сервер на проект или меняет его принадлежность.
`delete`	удаление проекта	Удаляет проект и отвязывает указанные серверы.
`edit`	редактирование проекта	Изменяет параметры существующего проекта.
`list`	получение списка проектов	Возвращает список всех доступных проектов пользователя.
`list_for_server`	получение проектов сервера	Возвращает список проектов, связанных с конкретным сервером.
`view`	просмотр проекта	Возвращает детальную информацию о конкретном проекте.

projects/add¶

Создает новый проект с указанным именем.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[name]=New Project"

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

{
"result": "OK",
"action": "add",
"data": {
"id": 123,
"name": "New Project",
"customer_id": 45,
"created_at": "2024-05-20T12:00:00Z"
}
}

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

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

projects/assign¶

Назначает сервер на проект или меняет его принадлежность.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `assign`
token	✅	string	Токен авторизации
params[id]	❌	integer	ID проекта.
params[server_id]	❌	integer	ID сервера.
params[assign]	❌	integer	Значение назначения (0 или 1).

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

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=assign" \
--data "token=YOUR_TOKEN" \
--data "params[id]=123" \
--data "params[server_id]=456" \
--data "params[assign]=1"

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

{
"result": "OK",
"action": "assign",
"data": {
"id": 123,
"status": "active"
}
}

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

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

projects/delete¶

Удаляет проект и отвязывает указанные серверы.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
params[id]	❌	integer	ID проекта.
params[server_ids]	❌	`array<integer>`	Массив ID серверов для обработки. Принимает несколько значений: server_ids[]=1&server_ids[]=2

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

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=delete" \
--data "token=YOUR_TOKEN" \
--data "params[id]=123" \
--data "params[server_ids[]=1]" \
--data "params[server_ids[]=2]"

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

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

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

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

projects/edit¶

Изменяет параметры существующего проекта.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=edit" \
--data "token=YOUR_TOKEN" \
--data "params[id]=123" \
--data "params[name]=Updated Project Name"

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

{
"result": "OK",
"action": "edit",
"data": {
"id": 123,
"name": "Updated Project Name"
}
}

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

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

projects/list¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "list",
"data": [
{
"id": 1,
"name": "Project Alpha",
"customer_id": 45
},
{
"id": 2,
"name": "Project Beta",
"customer_id": 45
}
]
}

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

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

projects/list_for_server¶

Возвращает список проектов, связанных с конкретным сервером.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=list_for_server" \
--data "token=HOSTKEY_TOKEN" \
--data "params[server_id]=55"

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

{
"result": "OK",
"action": "list_for_server",
"data": [
{
"id": 10,
"name": "Server Project",
"server_id": 55
}
]
}

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

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

projects/view¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "view",
"data": {
"id": 123,
"name": "Project Details",
"customer_id": 45,
"created_at": "2024-01-01T00:00:00Z"
}
}

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

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