inputFile

Prev Next

Classic/VPC環境で利用できます。

File Filterで分析するファイルを転送します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /filefilter/v1/inputFile

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド 必須の有無 説明
Content-Type Required リクエストおよびレスポンスデータ形式
  • multipart/form-data

File Safer APIで共通して使用されるヘッダの詳細は、File Safer APIのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
file File Required 対象ファイル
archivePassword String Conditional 圧縮ファイルのパスワード
  • 対象ファイルにパスワードが設定されている圧縮ファイルの場合、入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"{File Name}"'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
returnCode String Required レスポンスコード
returnMessage String Required レスポンスメッセージ

レスポンスステータスコード

File Safer APIで共通して使用されるレスポンスステータスコードの詳細は、File Saferのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "returnCode": "0",
    "returnMessage": "success"
}