Enviar aplicação - Square Cloud

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: SUA_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: 'SUA_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'SUA_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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

O upload cria uma aplicação totalmente nova a partir de um arquivo zip: detecta a runtime e a versão, provisiona um container no cluster com o menor uso de RAM no momento e o inicia. Use isso para um primeiro deploy; para enviar uma alteração a uma aplicação que já existe, use Enviar commit da aplicação, que é mais rápido porque não reprovisiona o container. Quem chamar o endpoint precisa ter pelo menos 256 MB de memória disponível no plano antes de o upload ser aceito, e o zip tem um limite de 100 MB. Os campos da resposta dependem do seu squarecloud.config: description e subdomain só aparecem quando definidos lá, e language informa a runtime e a versão detectadas. As requisições possuem limite de taxa de 1 upload a cada 3 segundos por usuário. Depois que a aplicação estiver em execução, gerencie-a com Iniciar, Parar e Reiniciar, e verifique-a com Obter status da aplicação.

Parâmetros

file

obrigatório

A aplicação a ser enviada deve estar compactada em um arquivo zip (.zip) e o Content Type deve ser multipart/form-data.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID da aplicação enviada.

name

string

O nome da aplicação enviada.

description

string

A descrição da aplicação enviada.

domain

string

O subdomínio da aplicação enviada (null se não aplicável).

ram

number

O uso de RAM da aplicação enviada em MB.

cpu

number

O uso de CPU da aplicação enviada.

language

object

Mostrar Alternar objeto

name

string

A linguagem de programação da aplicação enviada.

version

string

A versão recomendada da linguagem de programação.

cluster

string

O cluster onde a aplicação está hospedada na nuvem.

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: SUA_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: 'SUA_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'SUA_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"
        }
    }
}

Erros comuns

Código	HTTP	Significado
`INVALID_CONTENT_TYPE`	415	O corpo da requisição não é `multipart/form-data`.
`INVALID_FILE`	400	Nenhum campo de arquivo foi encontrado nos dados do formulário.
`INVALID_FILENAME`	400	O nome do arquivo contém separadores de caminho, `..` ou caracteres de controle.
`INSUFFICIENT_MEMORY`	400	A conta tem menos de 256 MB de memória disponível no plano.
`UPLOAD_ABORTED`	400	O cliente desconectou antes do upload terminar.
`STORAGE_UPLOAD_FAILED`	400	O arquivo falhou ao ser enviado para o armazenamento; tente novamente mais tarde.
`CLUSTER_SELECTION_FAILED`	400	Nenhum cluster estava disponível para hospedar a aplicação.
`EMPTY_RESPONSE`	400	O cluster não retornou uma resposta utilizável.
`UPLOAD_FAILED`	400	Ocorreu um erro inesperado ao processar o upload.
`FILE_TOO_LARGE`	413	O upload excedeu o limite de tamanho de 100 MB.
`CLUSTER_MAINTENANCE_TRY_LATER`	503	O provisionamento de aplicações está temporariamente indisponível devido a manutenção.

Status de todas as aplicaçõesColetar informações de status de todas as suas aplicações em tempo real. Possui limite de taxa de 15 requisições a cada 60 segundos.

curl --request POST \
  --url https://api.squarecloud.app/v2/apps \
  --header 'Authorization: SUA_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: 'SUA_API_KEY' },
  body: form,
});

import requests

with open('application.zip', 'rb') as f:
    response = requests.post(
        'https://api.squarecloud.app/v2/apps',
        headers={'Authorization': 'SUA_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"
        }
    }
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns