Управление группами

Получить список групп

URL: /api/v1/groups/
Метод: GET
Описание: Возвращает список групп.

Параметры запроса:
Query Params

Параметр	Описание
name	Фильтр по названию группы

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

GET /api/v1/groups HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
  "data": [
    {
      "id": 1,
      "created_at": 1759303458,
      "updated_at": 1759303479,
      "name": "Группа 1",
      "description": "Описание группы 1",
      "hosts_ids": [1, 2]
    },
    {
      "id": 2,
      "created_at": 1759303488,
      "updated_at": 1759303499,
      "name": "Группа 2",
      "description": "Описание группы 2",
      "hosts_ids": []
    }
  ]
}

---

Создать группу

URL: /api/v1/groups/
Метод: POST
Описание: Создать группу.

Параметры запроса:
JSON Params

Параметр	Описание	Обязательный
name	Название группы	Да
description	Описание группы	Нет
hosts	Список id хостов, которые входят в группу	Нет

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

POST /api/v1/groups/ HTTP/1.1
Authorization: Bearer <token>

[
  {
    "name": "Группа",
    "description": "Описание группы",
    "hosts": [2]
  }
]

Пример ответа:

{
    "data": {
        "id": 1,
        "created_at": 1759319741,
        "updated_at": 1759319741,
        "name": "Группа",
        "description": "Описание группы",
        "hosts_ids": []
    }
}

---

Получить группу по ID

URL: /api/v1/groups/{id}
Метод: GET
Описание: Получить группу по id.

Параметры запроса:
Path Params

Параметр	Описание
id	ID группы, которую нужно получить

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

GET /api/v1/groups/1 HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
  "data": {
    "id": 1,
    "created_at": 1759303458,
    "updated_at": 1759303479,
    "name": "Группа",
    "description": "Описание группы",
    "hosts_ids": [2, 3]
  }
}

---

Обновить группу

URL: /api/v1/groups/{id}
Метод: PUT
Описание: Обновить данные группы по id.

Параметры запроса:
Path Params

Параметр	Описание	Обязательный
id	ID группы, которую нужно обновить	Да

JSON Params

Параметр	Описание	Обязательный
name	Название группы	Нет
description	Описание группы	Нет
hosts	Список id хостов	Нет

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

PUT /api/v1/groups/1 HTTP/1.1
Authorization: Bearer <token>

{
  "name": "newName",
  "description": "newDescription",
  "hosts": []
}

Пример ответа:

{
  "data": {
    "id": 1,
    "created_at": 1759303458,
    "updated_at": 1759303479,
    "name": "newName",
    "description": "newDescription",
    "hosts_ids": []
  }
}

---

Удалить группу

URL: /api/v1/groups/{id}
Метод: DELETE
Описание: Удалить группу по id.

Параметры запроса:
Path Params

Параметр	Описание
id	ID группы, которую нужно удалить

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

DELETE /api/v1/groups/1 HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

HTTP STATUS 204 No Content