yamory の使い方

yamory へようこそ! yamory の基礎知識と使い方をご紹介します。

アプリライブラリの脆弱性情報一覧を取得する

リクエスト

GET /v1/app-vulns
クエリ タイプ 内容
keyword string 指定された文字列が含まれる脆弱性を検索します。対象フィールドは、プロジェクトグループ、プロジェクト名、グループID,アーティファクトID、バージョン、脆弱性ID、概要です。
triageLevel string トリアージレベル。指定しない場合は全てのトリアージレベルが対象になります。複数指定する場合はカンマ区切りで列挙します。( immediate , delayed , minor , none )
status string ステータス。指定しない場合は全てのステータスが対象になります。複数指定する場合はカンマ区切りで列挙します。( open : 未対応, in_progress : 対応中, wont_fix_closed : 修正しない, not_vuln_closed : 誤検知, closed : 完了)
openTimestamp datetime 検出日時。指定日時以降に検出された脆弱性を検索します。指定可能な書式は YYYY-MM-DD , YYYY-MM-DDThh:mm:ssZ です。いずれも UTC として解釈されます。
page integer ページ。検索結果のインデックスを指定します。(0-)
size integer 1ページ中に含まれるレコード数です。最大 10,000 件まで指定できます。

リクエスト例

curl -XGET https://yamoryapi.yamory.io/v1/app-vulns?keyword=package.name&triageLevel=delayed&status=open&openTimestamp=2022-01-15&page=0&size=100 \
-H 'Accept: application/json' \
-H 'AUTHORIZATION: token xxxxxxxxxxxxxxxxx'

レスポンス

[{
  "id" : "string",
  "triageLevel" : "string",
  "status" : "string",
  "vulnTypes" : "string",
  "teamName" : "string",
  "projectGroupKey" : "string",
  "projectName" : "string",
  "packageName" : "string",
  "openSystem" : "boolean",
  "hasPoc" : "boolean",
  "referenceId" : "string",
  "solution" : "string",
  "fixPolicy" : "string",
  "scanTimestamp" : "string",
  "openTimestamp" : "string",
  "fixStartTimestamp" : "string",
  "closedTimestamp" : "string",
  "yamoryVuln" : "string",
}]
ステータスコード 内容
200 リクエストが正常に処理されたことを示します。取得件数が0件の場合もこのステータスコードが返却されます。
400 不正なリクエストです。リクエストヘッダまたはリクエストボディに問題がある場合に返却されます。
401 認証エラーです。 Authorization ヘッダが指定されていないか、指定された情報での認証が失敗した場合に返却されます。
404 URLで指定したリソースが存在しない場合に返却されます。
500 サーバー内部でエラーが発生した場合に返却されます。