Blob オブジェクトのアップロード

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./myphone.png'

import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

const params = new URLSearchParams({
  name: 'myfile',
  prefix: 'images',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('myphone.png', 'rb') as f:
    response = requests.post(
        'https://blob.squarecloud.app/v1/objects',
        headers={'Authorization': 'YOUR_API_KEY'},
        params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
        files={'file': ('myphone.png', f, 'image/png')},
    )

{
    "status": "success",
    "response": {
        "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
        "name": "test",
        "prefix": "images",
        "size": 416230,
        "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
    }
}

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

オブジェクトのアップロードは、単一のファイルをSquare Cloud Blob Storageにアップロードし、バケットのプロビジョニングやACLの管理を自分で行うことなく、そのまま埋め込みや共有ができるCDN配信のURLを返します。プラットフォーム上でホストされているアプリケーションの添付ファイル、生成されたエクスポート、ユーザーがアップロードするメディアなどを支える機能です。保存される拡張子は、multipart パートで送信したファイル名から取得されます (指定がない場合は宣言された MIME タイプ、次に bin にフォールバック) ので、必ず実際のファイル名を送信してください。実質的にあらゆるファイルタイプを受け付け、拒否されるのは実行ファイルとインストーラーのみです。オブジェクトには 7〜1825 日 (5 年) の範囲で自動有効期限を設定でき、期限を過ぎると配信されなくなります。単一のリクエストで受け付けるファイルは 512 バイトから 100 MB までで、これは Cloudflare のエッジが受け付ける最大ボディサイズです。それより大きい 1 GiB までのファイルは、チャンクアップロードフローを使用します。ファイルをアップロードした後は、オブジェクト一覧で参照し、オブジェクトの削除で削除し、アカウント統計でプランのクォータに対する使用量を追跡できます。

file

必須

FormData を使用します (multipart/form-data)。1 リクエストにつきファイルは 1 つのみです。
実際のファイル名を送信してください。保存される拡張子はそこから決定されます。

string

必須

ファイル名を表す文字列。(拡張子なし)
a〜z、A〜Z、0〜9、および _ のパターンに従う必要があります。(3〜32 文字)

string

ファイルのプレフィックスを表す文字列。
a〜z、A〜Z、0〜9、および _ のパターンに従う必要があります。(3〜32 文字)

number

ファイルの有効期限を示す数値で、7〜1825 日 (5 年) の範囲で指定します。

boolean

security hash が必要な場合は true に設定します。

boolean

ファイルを自動ダウンロードに設定する場合は true に設定します。

レート制限と同時実行数

アップロードには有料プランが必要です。

すべてのアカウントは、同時に進行できるアップロードが最大 4 件 です。4 件がまだ実行中の状態で別のアップロードを開始すると、TOO_MANY_CONCURRENT_UPLOADS (429) が返されます。
Hobby および Standard プランはさらに 1 秒あたり 1 アップロード に制限されています (RATE_LIMITED、429)。Pro および Enterprise プランは 1 秒あたりの制限の対象外です。

セキュリティのため、ブラウザがインラインでレンダリングする形式 (.html、.svg、.xml、.xhtml など) は常にダウンロードとして配信され (application/octet-stream として提供)、レンダリングされません。auto_download=true を設定すると、同じ強制ダウンロードの動作がすべてのファイルタイプに適用されます。

ファイルタイプ

登録された MIME タイプを持たない形式 (.bam、.vcf、.fasta、.fastq、.parquet、.h5、.npy など) を含め、実質的にあらゆる拡張子を受け付けます。MIME 許可リストはもう存在しません。

保存される拡張子は、multipart パートで送信されたファイル名から決定されます。指定がない場合は宣言された MIME タイプ、次に bin にフォールバックします。
複合的な圧縮サフィックスは保持されます: reads.fastq.gz は .gz ではなく .fastq.gz として保存されます。
配信時の Content-Type は拡張子からサーバー側で決定されます。未知の形式は application/octet-stream として配信されるため、レンダリングされずにダウンロードされます。
実行ファイルとインストーラーは BLOCKED_FILE_TYPE として拒否されます: exe, msi, dll, bat, cmd, com, scr, cpl, pif, hta, vbs, vbe, jse, wsf, wsh, msc, reg, lnk, sys, drv, ps1, apk, xpi。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は “success”、失敗した場合は “error” です。

object

表示オブジェクトを展開

string

アップロードされたファイルの ID。

string

アップロードされたファイルの名前。

string

ファイルが保存されたプレフィックス (prefix クエリの内容をそのまま返します。指定がなかった場合は省略されます)。

number

アップロードされたファイルのサイズ (バイト単位)。

string

アップロードされたファイルの公開 CDN URL: https://public-blob.squarecloud.dev/<user_id>/<key>。ここで key は [prefix/]name[_hash][-exN].ext の形式です (ハッシュおよび有効期限のサフィックスは使用時のみ付与され、拡張子はアップロードされたファイル名から決定されます)。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./myphone.png'

import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

const params = new URLSearchParams({
  name: 'myfile',
  prefix: 'images',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('myphone.png', 'rb') as f:
    response = requests.post(
        'https://blob.squarecloud.app/v1/objects',
        headers={'Authorization': 'YOUR_API_KEY'},
        params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
        files={'file': ('myphone.png', f, 'image/png')},
    )

{
    "status": "success",
    "response": {
        "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
        "name": "test",
        "prefix": "images",
        "size": 416230,
        "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
    }
}

トラブルシューティング

オブジェクト関連

// The provided object name is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_NAME"
}

// The provided object prefix is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_PREFIX"
}

// The provided expiration value for the object is invalid.
// Must be a number ranging from 7 to 1825. (value in days).
{
    "status": "error",
    "code": "INVALID_OBJECT_EXPIRE"
}

// The provided security hash boolean is invalid.
// Just set to true or false. 😅
{
    "status": "error",
    "code": "INVALID_OBJECT_SECURITY_HASH"
}

// The provided auto-download boolean is invalid.
// Just set to true or false. 😅
{
    "status": "error",
    "code": "INVALID_STORAGE_AUTO_DOWNLOAD"
}

ファイル関連

単一のリクエストで受け付けるのは最大 100 MB です。1 GiB までのファイルには、チャンクアップロードフローを使用してください。

// The provided file is invalid.
{
    "status": "error",
    "code": "INVALID_FILE"
}

// The file extension is malformed or too long.
{
    "status": "error",
    "code": "INVALID_FILE_TYPE"
}

// Executable/installer extensions (exe, msi, bat, apk, ...) are not accepted.
{
    "status": "error",
    "code": "BLOCKED_FILE_TYPE"
}

// The file size is too small (< 512 bytes).
{
    "status": "error",
    "code": "FILE_TOO_SMALL"
}

認証エラー

// The API key is missing or invalid. Set a valid key in the Authorization header.
{
    "status": "error",
    "code": "ACCESS_DENIED"
}

// The account has no active paid plan. Uploading to Blob Storage requires a paid plan.
{
    "status": "error",
    "code": "PERMISSION_DENIED"
}

ストレージのクォータ超過

// You have exceeded your storage quota. Delete some files or upgrade your plan.
{
    "status": "error",
    "code": "STORAGE_QUOTA_EXCEEDED"
}

無効なコンテンツタイプ

// This route only accepts multipart/form-data requests with exactly one file.
{
    "status": "error",
    "code": "INVALID_CONTENT_TYPE"
}

ペイロードが大きすぎます

単一のリクエストで受け付けるのは最大 100 MB です。1 GiB までのファイルには、チャンクアップロードフローを使用してください。

// A single request accepts up to 100 MB. Use /v1/objects/chunked for files up to 1 GiB.
{
    "status": "error",
    "code": "FILE_TOO_LARGE"
}

レート制限

// Per-second upload limit reached (Hobby/Standard: max 1 upload per second).
{
    "status": "error",
    "code": "RATE_LIMITED"
}

// Too many simultaneous uploads (max 4 in progress at a time per account).
{
    "status": "error",
    "code": "TOO_MANY_CONCURRENT_UPLOADS"
}

アップロード失敗

// Failed to upload object to storage. Please try again later.
{
    "status": "error",
    "code": "UPLOAD_FAILED"
}

オブジェクトの削除このドキュメントは、SquareCloud Blob API の DELETE /v1/objects エンドポイントの包括的な概要を提供します。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/objects?name=myfile&prefix=images&expire=30' \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./myphone.png'

import fs from 'node:fs';

const form = new FormData();
form.append('file', new Blob([fs.readFileSync('./myphone.png')]), 'myphone.png');

const params = new URLSearchParams({
  name: 'myfile',
  prefix: 'images',
  expire: '30',
});

const response = await fetch(`https://blob.squarecloud.app/v1/objects?${params}`, {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('myphone.png', 'rb') as f:
    response = requests.post(
        'https://blob.squarecloud.app/v1/objects',
        headers={'Authorization': 'YOUR_API_KEY'},
        params={'name': 'myfile', 'prefix': 'images', 'expire': 30},
        files={'file': ('myphone.png', f, 'image/png')},
    )

{
    "status": "success",
    "response": {
        "id": "3155597145698959364/images/test_lxch4k7y-07ee.png",
        "name": "test",
        "prefix": "images",
        "size": 416230,
        "url": "https://public-blob.squarecloud.dev/3155597145698959364/images/test_lxch4k7y-07ee.png"
    }
}

​レート制限と同時実行数

​ファイルタイプ

​レスポンス

​トラブルシューティング

​オブジェクト関連

​ファイル関連

​認証エラー

​ストレージのクォータ超過

​無効なコンテンツタイプ

​ペイロードが大きすぎます

​レート制限

​アップロード失敗

レート制限と同時実行数

ファイルタイプ

レスポンス

トラブルシューティング

オブジェクト関連

ファイル関連

認証エラー

ストレージのクォータ超過

無効なコンテンツタイプ

ペイロードが大きすぎます

レート制限

アップロード失敗