Anwendung hochladen

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

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope apps:write. Upload erstellt eine brandneue Anwendung aus einem Zip-Archiv: Es erkennt Laufzeitumgebung und Version, provisioniert einen Container auf dem Cluster mit der aktuell niedrigsten RAM-Auslastung und startet ihn. Verwende dies für die erste Bereitstellung; um eine Änderung an einer bereits bestehenden Anwendung zu übertragen, verwende stattdessen Anwendung committen, was schneller ist, da der Container nicht neu provisioniert wird. Der Aufrufer benötigt mindestens 256 MB verfügbaren Speicher in seinem Plan, damit der Upload akzeptiert wird, und das Zip ist auf 100 MB begrenzt. Die Felder der Antwort hängen von deiner squarecloud.config ab: description und domain sind nur vorhanden, wenn dort gesetzt, und language meldet die erkannte Laufzeitumgebung und Version. Anfragen sind auf 1 Upload alle 3 Sekunden pro Benutzer begrenzt. Der Request-Body ist auf 101 MB begrenzt (eine Datei von bis zu 100 MB plus Formular-Overhead): Eine größere Anfrage wird noch während des Uploads mit 413 FILE_TOO_LARGE abgelehnt. Nur der erste Datei-Teil wird gelesen; zusätzliche Formularfelder werden ignoriert. Sobald die Anwendung läuft, verwalte sie mit Start, Stopp und Neustart und überprüfe sie mit Anwendungsstatus abrufen.

Parameter

file

erforderlich

Die hochzuladende Anwendung muss in einer ZIP-Datei (.zip) komprimiert sein und der Content-Type muss multipart/form-data sein.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

string

Die ID der hochgeladenen Anwendung.

string

Der Name der hochgeladenen Anwendung.

string

Die Beschreibung der hochgeladenen Anwendung.

string

Der vollständige Host der Anwendung, zum Beispiel my-app.squareweb.app. Nur vorhanden, wenn squarecloud.config SUBDOMAIN setzt. Es ist dasselbe Feld, das Anwendungsinformationen abrufen zurückgibt.

number

Der der Anwendung zugewiesene Speicher, in MB.

number

Die der Anwendung zugewiesene CPU.

object

Anzeigen Objekt umschalten

string

Die erkannte Runtime, in Kleinbuchstaben (zum Beispiel javascript), wie in Anwendungsinformationen abrufen.

string

Die empfohlene Version der Programmiersprache.

string

Der Cluster, in dem die Anwendung in der Cloud gehostet wird.

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

Häufige Fehler

Code	HTTP	Bedeutung
`INVALID_CONTENT_TYPE`	415	Der Request-Body ist kein `multipart/form-data`.
`INVALID_FILE`	400	Im Formulardatensatz wurde kein Dateifeld gefunden.
`INVALID_FILENAME`	400	Der Dateiname enthält Pfadtrennzeichen, `..` oder Steuerzeichen.
`INSUFFICIENT_MEMORY`	400	Das Konto hat weniger als 256 MB verfügbaren Speicher in seinem Plan.
`UPLOAD_ABORTED`	400	Der Client hat die Verbindung getrennt, bevor der Upload abgeschlossen war.
`STORAGE_UPLOAD_FAILED`	400	Die Datei konnte nicht in den Speicher hochgeladen werden; versuche es später erneut.
`CLUSTER_SELECTION_FAILED`	400	Es war kein Cluster verfügbar, um die Anwendung zu hosten.
`EMPTY_RESPONSE`	400	Der Cluster hat keine verwertbare Antwort zurückgegeben.
`UPLOAD_FAILED`	400	Beim Verarbeiten des Uploads ist ein unerwarteter Fehler aufgetreten.
`FILE_TOO_LARGE`	413	Die Datei hat 100 MB oder der Request-Body hat 101 MB überschritten.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	Die Anwendungsbereitstellung ist aufgrund von Wartungsarbeiten vorübergehend nicht verfügbar.
`UPLOAD_BUSY`	503	Es werden gerade zu viele Uploads verarbeitet; versuche es gleich erneut.

Siehe auch

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

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch