開発者用REST APIのFAQ

FutureVulsの開発者用REST APIを使うと、FutureVuls内のデータをHTTPで取得、操作できます。よくある質問と回答を掲載します。

API用のトークンがどこにあるかわからない

API用のトークンは、「グループ設定」->「トークン」で作成、確認できます。 こちらでは、scanner用のtokenとAPI用のtokenを管理できます。

APIでinvalid tokenが出る

使用しているtokenにAPI権限があるか確認してください。 権限がない場合は、既存のtokenに権限を付与するか、新しいtokenをAPI権限を付与した状態で作成し、使用してください。

APIで追加・更新・取得できる値を把握したい

開発者APIドキュメントより各APIの仕様をご確認いただけます。 追加・更新可能な値はParameters、取得できる値はResponsesの欄をご覧ください。 また、ParametersのModelタブにて*がついている値は必須の値です。

image.png

SwaggerのドキュメントからAPIが実行できない

現在、Swaggerのドキュメントから直接APIを叩くことはできません。 ご自身のパソコンからcurlコマンドなどを叩いて確認してください。 curl -H 'Authorization:xxxxxxxxxxxxxxxxxxxxx' 'https://rest.vuls.biz/v1/cves'

リスト取得系のAPIで一部の情報しか取得できない

FutureVulsのリスト取得系APIではページネーション機能を採用しており、デフォルトの1APIあたりの取得件数は20件となっています。取得できない情報がある場合は取得件数をオプションで指定して実行してください。（上限は1000件）

`curl -H 'Authorization:xxxxxxxxxxxxxxxxxxxxx' 'https://rest.vuls.biz/v1/cves?limit=1000'`

その他ページネーション機能のオプションはマニュアルを参照ください。

APIの同時接続数の上限はありますか

現状、常識の範囲内のアクセスでは同時実行数の制限にはあたらないような設定となっています。 （毎秒数百-数千リクエスト以上にならない限り同時接続エラーにはならないです）

ただし今後APIの利用状況やサービスに与える影響をモニタして public APIのrate limitを設定する可能性は十分に有ります。

RESTを用いたクライアント側の実装は、 サービス側の設定変更による同時接続エラーが起きても良いよう、 exponential backoffのような仕組みでリトライするような実装をおすすめします。