Управление задачами

Получить список задач

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

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

Параметр	Описание	Обязательное
Фильтр
type	Фильтр по типу задачи
name	Фильтр по названию задачи
status	Фильтр по статусу задачи
Пагинация
limit	Максимальное количество задач возвращаемое в ответе
page	Номер страницы
reverse	Обратная сортировка

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

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

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

{
    "data": {
        "active_tasks": [
            {
                "id": 10,
                "created_at": 1750083001,
                "updated_at": 1750083001,
                "number_task": "TASK-00010",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 11,
                "created_at": 1750083256,
                "updated_at": 1750083256,
                "number_task": "TASK-00011",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 12,
                "created_at": 1750083380,
                "updated_at": 1750083380,
                "number_task": "TASK-00012",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
        ]
      }
    }

Получить список активных задач

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

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

Параметр	Описание	Обязательное
Фильтр
type	Фильтр по типу задачи
name	Фильтр по названию задачи
status	Фильтр по статусу задачи
Пагинация
limit	Максимальное количество задач возвращаемое в ответе
page	Номер страницы
reverse	Обратная сортировка

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

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

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

{
    "data": {
        "active_tasks": [
            {
                "id": 10,
                "created_at": 1750083001,
                "updated_at": 1750083001,
                "number_task": "TASK-00010",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 11,
                "created_at": 1750083256,
                "updated_at": 1750083256,
                "number_task": "TASK-00011",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 12,
                "created_at": 1750083380,
                "updated_at": 1750083380,
                "number_task": "TASK-00012",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
        ]
      }
    }

Получить список архивных задач

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

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

Параметр	Описание	Обязательное
Фильтр
type	Фильтр по типу задачи
name	Фильтр по названию задачи
status	Фильтр по статусу задачи
Пагинация
limit	Максимальное количество задач возвращаемое в ответе
page	Номер страницы
reverse	Обратная сортировка

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

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

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

{
    "data": {
        "active_tasks": [
            {
                "id": 10,
                "created_at": 1750083001,
                "updated_at": 1750083001,
                "number_task": "TASK-00010",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 11,
                "created_at": 1750083256,
                "updated_at": 1750083256,
                "number_task": "TASK-00011",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
            {
                "id": 12,
                "created_at": 1750083380,
                "updated_at": 1750083380,
                "number_task": "TASK-00012",
                "template_id": 12,
                "task_type": "",
                "status": "working",
                "percent": 0,
                "state": "Начало"
            },
        ]
      }
    }

Получить задачу по id

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

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

Параметр	Описание
id	id задачи которую нужно получить

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

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

JSON ответ

{
    "data": {
        "id": 8,
        "created_at": 1749628819,
        "updated_at": 1749628837,
        "number_task": "TASK-00008",
        "template_id": null,
        "task_type": "",
        "status": "completed",
        "percent": 100,
        "state": "Пинг хостов завершен"
    }
}

Получить отчет задачи json

URL: /api/v1/tasks/{id}/json Метод: GET
Описание: Получить отчет задачи в формате json по id.

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

Параметр	Описание
id	id задачи которого нужно получить

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

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

Получить отчет задачи html

URL: /api/v1/tasks/{id}/html Метод: GET
Описание: Получить отчет задачи в формате html по id.

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

Параметр	Описание
id	id задачи которого нужно получить

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

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

Получить отчет задачи pdf

URL: /api/v1/tasks/{id}/pdf Метод: GET
Описание: Получить отчет задачи в формате pdf по id.

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

Параметр	Описание
id	id задачи которого нужно получить

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

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

Удалить задачу

URL: /api/v1/tasks/{id}
Метод: DELETE
Описание: Удалить задачу

Path Params

Параметр	Описание
id	id задачи которую нужно удалить

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

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

Получить задачу по id шаблона

URL: /api/v1/tasks/template/{id} Метод: GET
Описание: Получить задачу по id шаблона.

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

Параметр	Описание
id	id шаблона по которому нужно получить задачи

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

GET /api/v1/tasks/template/8 HTTP/1.1
Authorization: Bearer <token>

JSON ответ

{
    "data": [
      {
        "id": 8,
        "created_at": 1749628819,
        "updated_at": 1749628837,
        "number_task": "TASK-00008",
        "template_id": 8,
        "task_type": "pentest",
        "status": "completed",
        "percent": 100,
        "state": "Пинг хостов завершен"
    },
    {
        "id": 9,
        "created_at": 1749628992,
        "updated_at": 1749628999,
        "number_task": "TASK-00009",
        "template_id": 8,
        "task_type": "pentest",
        "status": "completed",
        "percent": 100,
        "state": "Пинг хостов завершен"
    },
    ]
}