multipart/form-data で受け取り、リアルタイムは Server-Sent Events をストリーミングします。
ベース URL
このリファレンスのすべてのエンドポイントは、次の URL からの相対パスです。https://blob.squarecloud.app/v1 を持つ別の API で、同じ API キーを使います。
認証
アカウントのセキュリティ設定で API キーを作成し、すべてのリクエストのAuthorization ヘッダーで送信します。Bearer プレフィックスは任意です。
最初のリクエスト
アカウント情報の取得は、プロフィール、プラン、所有するすべてのアプリケーションとデータベースを返します。account:read スコープを持つキーが必要です。
401 ACCESS_DENIED が返された場合は、キーがないか認識されていません。403 MISSING_SCOPE が返された場合は、キーは有効ですが account:read がありません。
レスポンスの形式
成功した呼び出しは2xx と "status": "success" を返し、返すデータがある場合は response に含めます。
{ "status": "success" } だけを返します。失敗した呼び出しは 4xx または 5xx と "status": "error"、そして分岐に使う code を返します。
snake_case です。すべてのコードとその対処方法はエラーに記載しています。
ID
- アプリケーションとデータベースは、
a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5dのような 32 文字の 16 進数の id を持ちます。アカウント情報の取得か、ダッシュボードのリソースのアドレスから取得できます。 - workspace 経由で共有されたアプリケーションは、パス内で
<appId>-<workspaceId>として指定します。例:/v2/apps/<appId>-<workspaceId>/status。 - workspace は 32 文字の 16 進数の id を持ちます。古い workspace は 40 文字の id のままです。
制限
各アカウントには、プランで決まる 60 秒あたりのリクエスト枠があり、一部のエンドポイントには各ページに記載された独自の制限があります。値は制限と制約を、429 の仕組みはエラーを参照してください。
OpenAPI 仕様
API 全体はhttps://api.squarecloud.app/v2/openapi.json の OpenAPI ドキュメントに記述されています。Postman や Insomnia にインポートしたり、クライアントを生成したりできます。
次のステップ
認証とスコープ
各連携に必要なスコープを選びます。
エラーコード
API が返すすべてのコードと対処方法。
アプリケーションのアップロード
1 回のリクエストで zip をデプロイします。
レート制限
プランごとのリクエスト枠。

