Upload application

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

required

The API key for your account. You can find this in your account settings.

Requires an API key with the apps:write scope. Upload creates a brand-new application from a zip archive: it detects the runtime and version, provisions a container on whichever cluster currently has the lowest RAM usage, and starts it. Use this for a first deployment; for pushing a change to an application that already exists, use Commit Application instead, which is faster because it does not re-provision the container. The caller needs at least 256 MB of available memory on their plan before the upload is accepted, and the zip is capped at 100 MB. The response fields depend on your squarecloud.config: description and domain are only present when set there, and language reports the detected runtime and version. Requests are rate limited to 1 upload every 3 seconds per user. The request body is limited to 101 MB (a file of up to 100 MB plus form overhead): a larger request is rejected with 413 FILE_TOO_LARGE while it is still uploading. Only the first file part is read; additional form fields are ignored. Once the application is running, manage it with Start, Stop, and Restart, and check on it with Get Application Status.

Parameters

file

required

The application to be uploaded must be compressed in a zip file (.zip) and the Content-Type must be multipart/form-data.

Response

string

Indicates whether the call was successful: success if it was, error if not.

object

The contents of the response.

Show Toggle object

string

The ID of the uploaded application.

string

The name of the uploaded application.

string

The description of the uploaded application.

string

The full host of the application, for example my-app.squareweb.app. Present only when squarecloud.config sets SUBDOMAIN. It is the same field that Get Application Info returns.

number

The memory allocated to the application, in MB.

number

The CPU allocated to the application.

object

Show Toggle object

string

The detected runtime, in lowercase (for example javascript), as in Get Application Info.

string

The recommended version of the programming language.

string

The cluster where the application is cloud hosted.

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"
        }
    }
}

Common errors

Code	HTTP	Meaning
`INVALID_CONTENT_TYPE`	415	The request body is not `multipart/form-data`.
`INVALID_FILE`	400	No file field was found in the form data.
`INVALID_FILENAME`	400	The file name contains path separators, `..`, or control characters.
`INSUFFICIENT_MEMORY`	400	The account has less than 256 MB of available memory on its plan.
`UPLOAD_ABORTED`	400	The client disconnected before the upload finished.
`STORAGE_UPLOAD_FAILED`	400	The file failed to upload to storage; retry later.
`CLUSTER_SELECTION_FAILED`	400	No cluster was available to host the application.
`EMPTY_RESPONSE`	400	The cluster did not return a usable response.
`UPLOAD_FAILED`	400	An unexpected error occurred while processing the upload.
`FILE_TOO_LARGE`	413	The file exceeded 100 MB or the request body exceeded 101 MB.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	Application provisioning is temporarily unavailable due to maintenance.
`UPLOAD_BUSY`	503	Too many uploads are being processed right now; retry in a moment.

CLI: squarecloud upload
SDKs: api.apps.create() (JavaScript), client.apps.create() (Python), c.Apps.Create() (Go)

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"
        }
    }
}

Get started

Account

Applications

Databases

Workspaces

AI

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related