アプリケーションのアップロード

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./application.zip'

import fs from 'node:fs';

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

const response = await fetch('https://api.squarecloud.app/v2/apps', {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'YOUR_API_KEY'},
        files={'file': ('application.zip', f, 'application/zip')},
    )

{
    "status": "success",
    "response": {
        "id": "945f574e6cc14ea6818f91d7d56de101",
        "name": "My Website",
        "description": "My first website on Square Cloud",
        "domain": "my-website.squareweb.app",
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "javascript",
            "version": "recommended"
        }
    }
}

string

必須

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

apps:write スコープを持つ API キーが必要です。アップロードは、zip アーカイブから新しいアプリケーションを作成します。ランタイムとバージョンを検出し、その時点で RAM 使用率が最も低い cluster にコンテナをプロビジョニングして起動します。これは初回デプロイ用です。すでに存在するアプリケーションに変更をプッシュする場合は、代わりにアプリケーションへのコミットを使用してください。コンテナを再プロビジョニングしない分、こちらの方が高速です。アップロードが受け付けられるには、呼び出し元のプランに 256 MB 以上の空きメモリ が必要で、zip は 100 MB までに制限されています。レスポンスのフィールドは squarecloud.config の内容によって変わります。description と domain は設定されている場合にのみ含まれ、language は検出されたランタイムとバージョンを報告します。リクエストはユーザーごとに 3 秒あたり 1 アップロードにレート制限されています。リクエストボディは 101 MB（最大 100 MB のファイルとフォームのオーバーヘッド）までに制限されており、これを超えるリクエストはアップロード中の段階で 413 FILE_TOO_LARGE として拒否されます。読み取られるのは最初のファイルパートのみで、追加のフォームフィールドは無視されます。アプリケーションが起動したら、起動、停止、再起動で管理し、アプリケーションのステータス取得で状態を確認してください。

パラメーター

file

必須

アップロードするアプリケーションはzipファイル（.zip）で圧縮する必要があり、Content-Typeはmultipart/form-dataである必要があります。

レスポンス

string

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

object

レスポンスの内容です。

表示 Toggle object

string

アップロードされたアプリケーションのIDです。

string

アップロードされたアプリケーションの名前です。

string

アップロードされたアプリケーションの説明です。

string

アプリケーションの完全なホストです。例: my-app.squareweb.app。squarecloud.config で SUBDOMAIN が設定されている場合にのみ含まれます。アプリケーション情報の取得が返すものと同じフィールドです。

number

アプリケーションに割り当てられたメモリ（MB単位）です。

number

アプリケーションに割り当てられた CPU です。

object

表示 Toggle object

string

検出されたランタイムを小文字で示します（例: javascript）。アプリケーション情報の取得と同じ形式です。

string

プログラミング言語の推奨バージョンです。

string

アプリケーションがクラウドホスティングされているクラスターです。

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: YOUR_API_KEY' \
  --form 'file=@./application.zip'

import fs from 'node:fs';

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

const response = await fetch('https://api.squarecloud.app/v2/apps', {
  method: 'POST',
  headers: { Authorization: 'YOUR_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'YOUR_API_KEY'},
        files={'file': ('application.zip', f, 'application/zip')},
    )

{
    "status": "success",
    "response": {
        "id": "945f574e6cc14ea6818f91d7d56de101",
        "name": "My Website",
        "description": "My first website on Square Cloud",
        "domain": "my-website.squareweb.app",
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "javascript",
            "version": "recommended"
        }
    }
}

一般的なエラー

コード	HTTP	説明
`INVALID_CONTENT_TYPE`	415	リクエストボディが `multipart/form-data` ではありません。
`INVALID_FILE`	400	フォームデータにファイルフィールドが見つかりませんでした。
`INVALID_FILENAME`	400	ファイル名にパス区切り文字、`..`、または制御文字が含まれています。
`INSUFFICIENT_MEMORY`	400	アカウントのプランに割り当てられた空きメモリが 256 MB 未満です。
`UPLOAD_ABORTED`	400	アップロードが完了する前にクライアントが切断しました。
`STORAGE_UPLOAD_FAILED`	400	ファイルのストレージへのアップロードに失敗しました。しばらくしてから再試行してください。
`CLUSTER_SELECTION_FAILED`	400	アプリケーションをホストできるクラスターが見つかりませんでした。
`EMPTY_RESPONSE`	400	クラスターが有効なレスポンスを返しませんでした。
`UPLOAD_FAILED`	400	アップロードの処理中に予期しないエラーが発生しました。
`FILE_TOO_LARGE`	413	ファイルが 100 MB を超えたか、リクエストボディが 101 MB を超えました。
`CLUSTER_MAINTENANCE_TRY_LATER`	503	メンテナンスのため、アプリケーションのプロビジョニングは一時的に利用できません。
`UPLOAD_BUSY`	503	現在処理中のアップロードが多すぎます。しばらくしてから再試行してください。

はじめに

アカウント