API V3 マニュアル > リファレンス > files

ファイルをアップロードします。
multipart/form-data形式でアップロードしたいファイルとパラメータを送信してください。

HTTP リクエスト

POST http://<ホスト名>/fileblog/api/v3/files/upload
Authorization: Bearer <アクセストークン>
Content-Type: multipart/form-data; boundary=---------------boundary

---------------boundary
Content-Disposition: form-data; name="file"; filename="sample.txt"

<ファイルボディ>
---------------boundary
Content-Disposition: form-data; name="parameters"
Content-Type: application/json; charset=utf-8

{path:"/DocRoot/sample.txt", mode:"add"}
---------------boundary

※パラメータ部のデータ名は"parameters"を指定しください。

※ファイル本体部のデータ名は"file"を指定しください。

※アクセストークンについてはこちらをご覧ください。

リクエストパラメータ

名前	型	説明
path	String, 必須	アップロード先のファイルのパスを指定します。パスについてはこちらをご覧ください。
mode	String	同名ファイルが存在した場合の動作を指定します。addが指定された場合に、既存ファイルがあると上書きを失敗させます。overwriteは上書きします。デフォルトはaddです。

リクエストパラメータはファイル本体と一緒にマルチパートで送信してください。フォームデータ名は"parameters"としてください。またContent-Type: application/json; charset=utf-8を忘れずに指定してください。

レスポンス

HTTP/1.1 200 OK
{
"result": true
}

リクエストが成功すると、レスポンスコードが200、レスポンスボディにJson形式で結果が返されます。

レスポンスパラメータ

名前	値	説明
result	Boolean	成功の場合はtrueが返ります。

エラーレスポンス

modeパラメータにaddもしくはoverwrite以外の値が指定されました

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/upload\": \"parameters\" in multipart/form: unsupported mode (allowed=add,overwrite)"
}
}

addもしくはoverwriteを指定してください。

0バイトのファイルをアップロードしようとしています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "0KB のファイルはアップロードできません (/DocRoot/bbb5.txt)"
}
}

1バイト以上のファイルをアップロードしてください。

同名ファイルが存在しています

HTTP/1.1 403 Forbidden
{
"error": {
"message": "同じ名前のファイルが既に存在しています。削除してからアップロードして下さい (/DocRoot/sample.txt)"
}
}

アップロード先に同名ファイルが存在しました。（削除してからアップロードするか、modeにoverwriteを指定して上書きすることもできます）

アップロードサイズ上限を超えています

HTTP/1.1 413 Request Entity Too Large
{
"error": {
"message": "Request Entity Too Large"
}
}

アップロードするファイルのサイズが設定上限を超えています。システム設定のupload_max_filesize_kbを確認してください。

ディスクに空き領域がありません

{
"error": {
"message": "ディスクに十分な空き領域がありません。 (112) (/DocRoot/sample.zip)"
}
}

ディスクに空き領域がないためアップロードに失敗しています。

アップロードを許可されていないファイル種類です

HTTP/1.1 403 Forbidden
{
"error": {
"message": "これらの拡張子以外のファイルはアップロードできません (exe) (/DocRoot/sample.exe)"
}
}

アップロードするファイルの拡張子が設定で許可されていません。システム設定のuploadable_extlistを確認してください。

ファイル本体部の(file)パートが見つかりません

HTTP/1.1 403 Forbidden
{
"error": {
"message": "Error in call to API function \"files/upload\": \"parameters\" in multipart/form: missing required field \"file\" in multipart/formdata."
}
}

※ファイル本体部のデータ名は"file"を指定しください。

※その他のエラーについてはこちらをご覧ください。