Формат POST-запроса на сканирование

05 марта 2024

ID 193000

POST-запросы на сканирование объекта имеют следующий формат:

* Заголовки запроса *

 

* Тело запроса *

{

"timeout": "%TIMEOUT%",

"omitCleanSubobjectResults": %TO_OMIT_CLEAN_SUBOBJECT_RESULTS%,

"url": "%URL%",

"hostIp": "%HOST_IP%",

"requestHeaders": "%REQUEST_HEADERS%",

"responseHeaders": "%RESPONSE_HEADERS%",

"object": "%OBJECT%",

"name": "%SCAN_OBJECT_NAME%"

}

Здесь:

  • timeout – тайм-аут на сканирование объекта (в миллисекундах). Это поле не является обязательным.
  • omitCleanSubobjectResults – переменная логического типа, которая определяет, будут ли включены в массив subObjectsScanResults вложенные объекты с результатом сканирования CLEAN. Если указано значение true, такие объекты не будут включены в массив; если указано значение false, то такие объекты включаются в массив. Значение по умолчанию: true. Это поле не является обязательным.

    Смотрите также подробную информацию о структуре массива subObjectsScanResults.

  • url – URL-адрес, который будет использован как контекст для запроса на сканирование. Это поле не является обязательным.

    Это поле можно использовать для повышения коэффициента обнаружения.

  • hostIp – IP-адрес хоста, на котором размещен просканированный URL-адрес. Это поле не является обязательным.

    Это поле можно использовать для повышения коэффициента обнаружения. Вам необходимо включить KSN, чтобы использовать это поле.

  • requestHeaders – заголовки HTTP-запроса, извлеченные из HTTP-трафика. Это поле не является обязательным.

    Это поле можно использовать для повышения коэффициента обнаружения.

  • responseHeaders – заголовки HTTP-ответа, извлеченные из HTTP-трафика. Это поле не является обязательным.

    Это поле можно использовать для повышения коэффициента обнаружения.

  • object – абсолютный путь до файла, который нужно просканировать (если запрос послан к /api/v3.0/scanfile), или строка, закодированная по алгоритму Base64 (если запрос послан к /api/v3.0/scanmemory). В этом поле можно указать только один объект. Это поле является обязательным для заполнения.
  • name – имя объекта для сканирования в режиме scanmemory (если запрос послан к /api/v3.1/scanmemory). Значение может быть от 1 до 300 символов Юникода. Это поле не является обязательным.

Специальные символы в теле запроса должны быть экранированы, как указано в Standard ECMA-404 (The JSON Interchange Syntax).

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!