Upload Application - Square Cloud

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

Authorization

string

required

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

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 subdomain 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. 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

status

string

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

response

object

The contents of the response.

Show Toggle object

string

The ID of the uploaded application.

name

string

The name of the uploaded application.

description

string

The description of the uploaded application.

domain

string

The subdomain of the uploaded application (null if not applicable).

ram

number

The RAM usage of the uploaded application in MB.

cpu

number

The CPU usage of the uploaded application.

language

object

Show Toggle object

name

string

The programming language of the uploaded application.

version

string

The recommended version of the programming language.

cluster

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": "Estrelinha Legal",
        "description": "Nossa, fui enviada na velocidade da luz! ✨",
        "domain": null,
        "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 upload exceeded the 100 MB size limit.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	Application provisioning is temporarily unavailable due to maintenance.

All Applications StatusCollect status information about all your applications in real time. It has a rate limit of 15 request every 60 seconds.

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

​Common errors

Parameters

Response

Common errors