Skip to content

Экспорт данных

Если вам необходимо экспортировать данные об уязвимостях из Vampy во внешнюю систему, то это можно сделать следующим способом

Экспорт в json

Для экспорта в формате json можно использовать API метод ext/v1/scan_issues/export.

Метод поддерживает следующие параметры:

  • payload - Может принимать значения: INLINE, ATTACHMENT, ARCHIVE
  • formatter - определяет формат результата. Может принимать значения: json
  • order - варианты сортировки. Может принимать значения (можно комбинировать через запятую): created, status, sla, parser, title, filePath, fileLineno, libraryName, libraryVersion, cveID, severity, cweID
  • search - строка, по которой можно отфильтровать уязвимости
  • statuses - позволяет задать статусы дефектов, которые будут экспортированы
  • severities - позволяет задать критичность дефектов, которые будут экспортированы
  • products - позволяет указать продукты дефекты, которых будут экспортированы
  • repositories - позволяет указать репозитории дефекты, которых будут экспортированы
  • repositoryBranches - позволяет указать ветки репозиториев дефекты, которых будут экспортированы
  • scanners - позволяет указать сканеры дефекты, которых будут экспортированы
  • scannerTypes - позволяет указать типы сканеров (SAST/DAST/SCA) дефекты, которых будут экспортированы
  • hasSolution - позволяет фильтровать дефекты по наличию в них исправлений. Может принимать значения: true/false
  • includeComments - позволяет указать необходимость экспорта комментариев к дефектам. Может принимать значения: true/false

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

curl -X 'GET' \
  'https://vampy_host/api/ext/v1/scan_issues/export/?payload=ARCHIVE&formatter=JSON&order=severity%2C-created&search=search_string&statuses=new%2Cconfirmed&severities=high%2Cinfo&products=Hive&scanners=SEMGREP%2CGRYPE&scannerTypes=SAST%2CDAST&includeComments=false' \
  -H 'accept: application/json'
  -H "Authentication: $VAMPY_API_TOKEN"\