tasks

Эндпоинт используется для управления задачами анализа и данными отчета.

GET tasks/<task_id:number>

Описание

Параметры

Результат

Получить данные о задаче.

Объект Task.

GET tasks/<task_id:number>/archive

Описание

Параметры

Результат

Скачать архив с результатами анализа.

Архив с результатами анализа.

GET tasks/<task_id:number>/sample

Описание

Параметры

Результат

Скачать файл, отправленный на анализ.

Файл, отправленный на анализ.

GET tasks/<task_id:number>/report

Описание

Параметры

Результат

Скачать одностраничный HTML-отчет.

Одностраничный HTML-отчет.

GET tasks/<task_id:number>/graph

Описание

Параметры

Результат

Скачать граф в формате SVG.

Граф в формате SVG.

GET tasks/<task_id:number>/dumps

Описание

Результат

Получить данные из таблицы Дампы памяти.

{

  "total_count": <число>,

  "items": <список объектов Dump>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/drops

Описание

Результат

Получить данные из таблицы Созданные файлы.

{

  "total_count": <число>,

  "items": <список объектов Drop>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/networks

Описание

Результат

Получить данные из таблицы Сетевая активность.

{

  "total_count": <число>,

  "items": <список объектов Connection>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

GET tasks/<task_id:number>/api_log

Описание

Результат

Получить данные из таблицы Журнал API.

{

  "total_count": <число>,

  "items": <список объектов APIEvent>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/mitre

Описание

Результат

Получить данные о созданной матрице MITRE ATT&CK.

{

  "type": <тип матрицы>,

  "matrix": <объект Matrix>,

  "errors": <объект Error>

}, где:

type — тип матрицы (возможные значения: enterprise и mobile);

matrix — матрица в виде списка техник и подтехник;

errors — список ошибочных техник, которые не удалось вставить в матрицу MITRE ATT&CK.

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/intents (опционально)

Описание

Результат

Получить данные из таблицы Намерения. Эндпоинт используется только для задач, запущенных на Android.

{

  "total_count": <число>,

  "items": <список объектов Intent>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/phone_actions (опционально)

Описание

Результат

Получить данные из таблицы Телефонные звонки и SMS. Используется только для задач, запущенных на Android.

{

  "total_count": <число>,

  "items": <список объектов Call и Message>

}

Параметры

Параметр

Тип

Описание

Обязательный

count

integer

Количество возвращаемых объектов, 1…100. Чтобы получить больше объектов, используйте несколько запросов и параметр offset. По умолчанию count=10.

Нет

offset

integer

Смещение, 0…+∞. По умолчанию offset=0.

Нет

search

string

Образец для поиска по строке.

Нет

GET tasks/<task_id:number>/archive_storage

Описание

Параметры

Результат

Получить список файлов и каталогов в архиве или скачать файл или каталог из архива.

path (string) — путь, необязательный параметр

Если path не указан:

{

  "folders": <список папок в архиве>,

  "files": <список файлов в архиве>

}

Если path указан — файл или архив папки.

POST tasks/<task_id:number>/restart

Описание

Параметры

Результат

Перезапустить удаленную или неудавшуюся задачу.

Перезапуск удаленной или неудавшейся задачи.