Blob 共有の作成

POST

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/shares' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "expires_in": 604800,
    "max_downloads": 5
  }'

const response = await fetch('https://blob.squarecloud.app/v1/shares', {
  method: 'POST',
  headers: {
    Authorization: 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    object: 'prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf',
    expires_in: 7 * 24 * 60 * 60,
    max_downloads: 5,
  }),
});

{
  "status": "success",
  "response": {
    "id": "q8Zr2LwX7nT0vKc4Hs1YbA",
    "url": "https://files.squarecloud.dev/s/q8Zr2LwX7nT0vKc4Hs1YbA",
    "expires_at": "2026-10-02T12:00:00.000Z",
    "max_downloads": 5,
    "password": false,
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "object_is_public": false
  }
}

string

必須

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

共有の作成は、1 つのファイルを人に渡すためのリンク (https://files.squarecloud.dev/s/...) を作成します: クライアント、チーム、テスターなどに渡すためのものです。公開ファイルとプライベートファイルの両方で機能し、最大 30 日間有効で、いつでも取り消すことができ、ファイルのダウンロード回数を制限できます。Pro と Enterprise では、パスワードを要求することもできます。blob:write スコープが必要です。リンクを開くとファイルがダウンロードされます。パスワード保護されたリンクでは、まず訪問者の言語でパスワードを求めるページが表示されます。リンクはファイルの現在の id に紐付けられています: ファイルを削除、移動したり公開範囲を変更したりすると、リンクはすぐに 404 を返し、ダウンロード回数は消費されません。一時リンクとの比較についてはリンクと共有を参照してください。

string

必須

共有するファイルの id。

number

デフォルト:"86400"

リンクの有効期間。60〜2592000 秒 (30 日) です。

number

リンクで許可されるダウンロード回数。1〜10000 です。使い切ると 410 を返します。指定しない場合は上限はありません。

string

訪問者がダウンロード前に入力する必要がある 8〜128 文字のパスワード。Pro と Enterprise のみ。

公開ファイルの場合、リンクは恒久的な公開 URL へリダイレクトし、リンクを開いた人はその URL を使い続けられます。パスワード、ダウンロード回数の上限、有効期限が本当に保護できるのはプライベートファイルだけです。

制限

1 分間に 30 リンク (RATE_LIMITED、429)、アカウントあたり有効なリンクは最大 1000 件 (TOO_MANY_SHARES、409)。
各リンクは IP あたり 1 分間に 120 回のアクセスを受け付けます。誤ったパスワードは IP ごと、リンクごとに制限されます。
プライベートファイルのダウンロードは一時リンクを経由します: IP あたり 1 分間に 60 リクエスト、およびアカウント全体の制限。ファイルを多くの人に渡すには、ファイルを公開してください。

レスポンス

201 Created を返します。

string

成功した場合は “success”、失敗した場合は “error” です。

object

表示オブジェクトを切り替え

string

共有 id。共有の削除で使用します。

string

配布するリンク。

ISO 8601

リンクの有効期限。

number | null

ダウンロード回数の上限、または null。

boolean

リンクがパスワードを要求するかどうか。

string

共有されたファイルの id。

boolean

ファイルが公開されている場合は true: 公開 URL を知っていれば誰でも引き続きダウンロードできるため、共有を取り消したり、回数を制限したり、パスワードで保護したりしても、ファイル自体へのアクセスは制限されません。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/shares' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "expires_in": 604800,
    "max_downloads": 5
  }'

const response = await fetch('https://blob.squarecloud.app/v1/shares', {
  method: 'POST',
  headers: {
    Authorization: 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    object: 'prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf',
    expires_in: 7 * 24 * 60 * 60,
    max_downloads: 5,
  }),
});

{
  "status": "success",
  "response": {
    "id": "q8Zr2LwX7nT0vKc4Hs1YbA",
    "url": "https://files.squarecloud.dev/s/q8Zr2LwX7nT0vKc4Hs1YbA",
    "expires_at": "2026-10-02T12:00:00.000Z",
    "max_downloads": 5,
    "password": false,
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "object_is_public": false
  }
}

エラー

コード	HTTP	発生する状況
`INVALID_OBJECT`	400	`object` がない、形式が正しくない、またはあなたのものではない。
`INVALID_EXPIRES_IN`	400	`expires_in` が 60〜2592000 の整数ではない。
`INVALID_MAX_DOWNLOADS`	400	`max_downloads` が 1〜10000 の整数ではない。
`INVALID_PASSWORD`	400	パスワードが 8〜128 文字ではない。
`UPGRADE_REQUIRED`	403	パスワードには Pro または Enterprise が必要。
`OBJECT_NOT_FOUND`	404	ファイルが存在しない。
`TOO_MANY_SHARES`	409	アカウントに 1000 件の有効なリンクがある。先にいくつかを取り消してください。
`RATE_LIMITED`	429	1 分間に 30 リンクを超えた。

curl --request POST \
  --url 'https://blob.squarecloud.app/v1/shares' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "expires_in": 604800,
    "max_downloads": 5
  }'

const response = await fetch('https://blob.squarecloud.app/v1/shares', {
  method: 'POST',
  headers: {
    Authorization: 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    object: 'prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf',
    expires_in: 7 * 24 * 60 * 60,
    max_downloads: 5,
  }),
});

{
  "status": "success",
  "response": {
    "id": "q8Zr2LwX7nT0vKc4Hs1YbA",
    "url": "https://files.squarecloud.dev/s/q8Zr2LwX7nT0vKc4Hs1YbA",
    "expires_at": "2026-10-02T12:00:00.000Z",
    "max_downloads": 5,
    "password": false,
    "object": "prv/3155597145698959364/reports/q3_mugws5c0-9f86d081884c7d659a2feaa0c55ad015.pdf",
    "object_is_public": false
  }
}

はじめに

オブジェクト

チャンクアップロード

アカウント

共有リンク

S3

制限

レスポンス

エラー

​制限

​レスポンス

​エラー

制限

レスポンス

エラー