projects¶

В этой статье

• Методы API
• projects/add
• projects/assign
• projects/delete
• projects/edit
• projects/list
• projects/list_for_server
• projects/view

(описание будет добавлено при генерации)

Методы API¶

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

projects/add¶

Создает новый проект для текущего клиента.

HTTP-метод: POST

Параметры:

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": 456,
"created_at": "2024-05-20T12:00:00Z"
}
}

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

projects/assign¶

Назначает сервер на проект.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=assign" \
--data "token=HOSTKEY_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

Параметры:

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

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

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

projects/edit¶

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

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/projects.php" -X POST \
--data "action=edit" \
--data "token=HOSTKEY_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

Параметры:

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": 456
},
{
"id": 2,
"name": "Project Beta",
"customer_id": 456
}
]
}

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

projects/list_for_server¶

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

HTTP-метод: POST

Параметры:

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

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

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

projects/view¶

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

HTTP-метод: POST

Параметры:

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": 456
}
}

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