API docs by Redocly

Malcheck API (1.0.0)

Download OpenAPI specification:

ウィルスチェックAPIのMalCheckドキュメント

scan

ウィルスをチェックします

ウィルスのチェックをリクエストします

Request Body schema: multipart/form-data
token
string

(必須) 認証トークン

url
string or null

(urlとfileはどちらか必須) チェックするURL。

file
string or null <binary>

(urlとfileはどちらか必須) チェックするファイル。上限 30MB。超過時は 413 を返します。

async
boolean or null

(任意) 1 / true を指定すると非同期モードになり、受付後すぐに id を返します。結果は GET /scan/{id} で取得します（ポーリング）。 コールバック用の公開エンドポイントを用意できない環境（社内システム、ローコード環境など）向けです。

callback_url
string or null

(任意) チェック結果を受け取るURL。指定される場合は非同期で結果を送信します。送信される内容は同期レスポンスの内容と同じJSONです。 status が error の場合も同じ形（data と message）を POST します。受付から 10 分以内に結果が出なかった場合はサーバー側で error に確定しますが、コールバックは送られません。 コールバックの代わりに、返された id で GET /scan/{id} を呼んで結果を取得することもできます（コールバックが届かなかった場合の確認にも使えます）。新規の実装では async + ポーリングを推奨します。

meta
string or null

(任意) 任意の文字列。そのままレスポンスに返ります。呼び出し側の識別子などに使えます。機密情報は入れないでください（検査履歴として 1 年保存されます）

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

検査結果を取得します（ポーリング）

POST /scan が返した id で検査の現在の状態を取得します。非同期モード（async または callback_url）の結果取得に使います。同期モードでクライアント側がタイムアウトした場合の確認にも使えます。

  • 該当する検査があれば status に関わらず HTTP 200 を返します。data.status で分岐してください（pending は検査中。数秒おきに再取得）
  • pending のまま受付から 10 分経過した検査はサーバー側で error に確定します
  • 他チームの id や存在しない id は 404 です
  • name は検査履歴に保存しないため（POST のレスポンスにだけ返します）、ここでは常に null です
path Parameters
id
required
integer
Example: 123456

POST /scan のレスポンスの data.id

query Parameters
token
required
string
Example: token=1234567890abcdef

認証トークン（POST /scan と同じ）

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "could not download url: HTTP 404"
}