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

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": "Estrelinha Legal",
        "description": "Nossa, fui enviada na velocidade da luz! ✨",
        "domain": null,
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "JavaScript",
            "version": "recommended"
        }
    }
}

string

必須

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

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

Parameters

file

必須

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

Response

string

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

object

レスポンスの内容です。

表示 Toggle object

string

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

string

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

string

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

string

アップロードされたアプリケーションのサブドメインです（該当しない場合はnull）。

number

アップロードされたアプリケーションのRAM使用量（MB単位）です。

number

アップロードされたアプリケーションのCPU使用量です。

object

表示 Toggle object

string

アップロードされたアプリケーションのプログラミング言語です。

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": "Estrelinha Legal",
        "description": "Nossa, fui enviada na velocidade da luz! ✨",
        "domain": null,
        "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 のサイズ上限を超えました。
`CLUSTER_MAINTENANCE_TRY_LATER`	503	メンテナンスのため、アプリケーションのプロビジョニングは一時的に利用できません。

全アプリケーションのステータスすべてのアプリケーションのステータス情報をリアルタイムで収集します。60秒あたり15リクエストのレート制限があります。

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": "Estrelinha Legal",
        "description": "Nossa, fui enviada na velocidade da luz! ✨",
        "domain": null,
        "ram": 1024,
        "cpu": 6,
        "language": {
            "name": "JavaScript",
            "version": "recommended"
        }
    }
}

​Parameters

​Response

​一般的なエラー

Parameters

Response

一般的なエラー