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

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Upload crée une toute nouvelle application à partir d’une archive zip : il détecte le runtime et sa version, provisionne un conteneur sur le cluster ayant actuellement l’utilisation de RAM la plus basse, et le démarre. Utilisez-le pour un premier déploiement ; pour pousser un changement vers une application qui existe déjà, utilisez plutôt Commiter une application, plus rapide car il ne re-provisionne pas le conteneur. L’appelant doit disposer d’au moins 256 Mo de mémoire disponible sur son plan pour que l’envoi soit accepté, et le zip est plafonné à 100 Mo. Les champs de la réponse dépendent de votre squarecloud.config : description et subdomain ne sont présents que s’ils y sont définis, et language indique le runtime et la version détectés. Les requêtes sont limitées à 1 envoi toutes les 3 secondes par utilisateur. Une fois l’application en cours d’exécution, gérez-la avec Démarrer, Arrêter et Redémarrer, et vérifiez son état avec Obtenir le statut d’une application.

Paramètres

file

requis

L’application à envoyer doit être compressée dans un fichier zip (.zip) et le Content-Type doit être multipart/form-data.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’ID de l’application envoyée.

string

Le nom de l’application envoyée.

string

La description de l’application envoyée.

string

Le sous-domaine de l’application envoyée (null si non applicable).

number

L’utilisation de RAM de l’application envoyée en Mo.

number

L’utilisation du CPU de l’application envoyée.

object

Afficher Afficher l'objet

string

Le langage de programmation de l’application envoyée.

string

La version recommandée du langage de programmation.

string

Le cluster sur lequel l’application est hébergée dans le 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"
        }
    }
}

Erreurs courantes

Code	HTTP	Signification
`INVALID_CONTENT_TYPE`	415	Le corps de la requête n’est pas `multipart/form-data`.
`INVALID_FILE`	400	Aucun champ de fichier n’a été trouvé dans les données du formulaire.
`INVALID_FILENAME`	400	Le nom du fichier contient des séparateurs de chemin, `..` ou des caractères de contrôle.
`INSUFFICIENT_MEMORY`	400	Le compte dispose de moins de 256 Mo de mémoire disponible sur son plan.
`UPLOAD_ABORTED`	400	Le client s’est déconnecté avant la fin de l’envoi.
`STORAGE_UPLOAD_FAILED`	400	Le fichier n’a pas pu être envoyé vers le stockage ; réessayez plus tard.
`CLUSTER_SELECTION_FAILED`	400	Aucun cluster n’était disponible pour héberger l’application.
`EMPTY_RESPONSE`	400	Le cluster n’a pas renvoyé de réponse exploitable.
`UPLOAD_FAILED`	400	Une erreur inattendue s’est produite lors du traitement de l’envoi.
`FILE_TOO_LARGE`	413	L’envoi a dépassé la limite de taille de 100 Mo.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	Le provisionnement d’applications est temporairement indisponible en raison d’une maintenance.

Statut de toutes les applicationsCollecter des informations de statut sur toutes vos applications en temps réel. Cette route a une limite de débit de 15 requêtes toutes les 60 secondes.

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

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes