Pular para o conteúdo principal
POST
curl
Envie o .zip como multipart/form-data no campo file. A configuração vem do cube.json na raiz do .zip, ou dos campos do formulário. Sem código ainda? Mande template no lugar do file e comece por um template da Cube.
1

Envio

A Cube confere o tamanho, extrai o .zip e valida a configuração. Se algo estiver errado, nada é criado e a resposta diz o motivo.
2

Instalação

O projeto nasce em installing. As dependências são instaladas e o build roda, se houver. Acompanhe pelos logs com source=build.
3

Pronto

Com start=true, o projeto sobe sozinho (running). Sem ele, fica stopped até você iniciar.
Para criar o projeto já ligado a um banco de dados da conta, mande databaseId (e, se quiser, o nome da variável em databaseVariable): a string de conexão entra como variável de ambiente antes da primeira subida.
Com template (a lista em Listar templates), o código e a configuração vêm do template: o formulário só troca o que você mandar, como name, memoryMb e subdomain. A resposta traz missingVariables, as variáveis obrigatórias do template que não vieram; com alguma, o projeto instala e fica stopped mesmo com start=true.
A memória mínima depende do plano: bot 256 MB nos planos pagos e 100 MB no Free; site ou API 512 MB. Sem memoryMb, vale o mínimo do seu plano. Veja Listar planos.
Guarde tokens em variáveis de ambiente, não no .zip: mande em variables (JSON [{"name": "DISCORD_TOKEN", "value": "..."}]) e elas são gravadas antes da primeira subida, ou defina depois em Definir variáveis e inicie.

Erros comuns

Todos os códigos, com o formato do erro, em Códigos de erro.

Autorizações

Authorization
string
header
obrigatório

Chave de API da Cube (cube_…), criada no painel em Chaves de API. Mande como Authorization: Bearer cube_…. Cada rota pede uma permissão da chave (o escopo no security da rota, como files:write); sem ela, 403 insufficient_scope com o requiredScope. Veja Chaves de API.

Scopes

projects:create

Corpo

multipart/form-data
file
file

O .zip com o código. Até 5 MB no Free e 10 MB nos planos pagos. Obrigatório, a não ser com template.

template
enum<string>

Um template da Cube no lugar do file (a lista em Listar templates). Com os dois, nada é criado.

Opções disponíveis:
discord-js-bot,
discord-py-bot,
discord-music-bot,
lavalink,
discord-postgres-bot,
express-api,
fastapi-api,
static-site
variables
string

Variáveis de ambiente gravadas antes da primeira subida, em JSON: [{"name": "DISCORD_TOKEN", "value": "..."}]. Até 50, com as regras de Definir variáveis.

start
enum<string>
padrão:false

true inicia o projeto assim que a instalação terminar.

Opções disponíveis:
true,
false
name
string

Nome do projeto. Vale se o cube.json não tiver name; sem nenhum, vira o nome do arquivo.

Required string length: 1 - 40
type
enum<string>

Mesmo significado da chave do cube.json.

Opções disponíveis:
bot,
site
language
enum<string>

Com language e command (ou language e entry; ou só language no static, o site só de HTML, no go, no rust, no elixir e no php), o formulário vale e o cube.json é ignorado.

Opções disponíveis:
node,
python,
java,
go,
php,
ruby,
dotnet,
elixir,
rust,
static
version
string

20, 22, 24 ou 26 (Node.js; sem ela, 24; o 20 está fora de suporte); 3.11, 3.12, 3.13 ou 3.14 (Python; sem ela, 3.12); 21 ou 25 (Java; sem ela, 21); 1.26 ou 1.27 (Go; sem ela, 1.27); 8.4 ou 8.5 (PHP; sem ela, 8.4); 3.4 ou 4.0 (Ruby; sem ela, 3.4); 10 (.NET); 1.20 (Elixir); 1.98 (Rust).

command
string

Comando de início, numa linha só. No go e no rust é opcional: sem ele, roda o programa que o build gera (/dados/bin/app; no Rust, o entry de src/bin/<nome>.rs roda o /dados/bin/<nome>). No site php também: sem ele, a Cube serve o site (cube-php-server, com a pasta root ou a public). No elixir também: sem ele, mix run --no-halt. Sem ele, com o entry, o comando sai do arquivo principal (no dotnet, o .dll publicado do projeto, dotnet /dados/publish/<projeto>.dll, ou o .dll pronto, dotnet <entry>).

Maximum string length: 500
entry
string

O arquivo principal, com a extensão da linguagem (como cmd/bot/main.go, src/Api/Api.csproj ou app.dll). No go, é a pasta que o build compila (sem ele, a raiz do .zip); no dotnet, o projeto que o build publica, em qualquer pasta (sem ele, o único projeto ou a solução da raiz), ou um .dll pronto, que roda sem build. Sem command, o comando sai dele. Fora do formato, 422 invalid_config com field: "entry".

Maximum string length: 200
memoryMb
integer

Memória em MB. O mínimo é o do plano: bot 256 nos planos pagos e 100 no Free; site 512. Sem ela, vale o mínimo do plano; com template, a memória sugerida dele, cortada no que sobra e nunca abaixo do mínimo (no Free, o bot entra com 100).

Intervalo obrigatório: x >= 100
port
integer

Só site. Padrão 8080.

Intervalo obrigatório: 1024 <= x <= 65535
subdomain
string

Só site. Sem ele, a Cube gera um.

build
string

Comando de build. Ausente = automático; vazio = sem build. O site estático não tem.

Maximum string length: 500
installCommand
string

Comando de instalação, no lugar da instalação automática da linguagem (como npm install --omit=dev). Ausente = a automática; vazio = não instala nada. Numa linha só, sem caractere de controle; fora disso, 422 invalid_config com field: "installCommand". O site estático não tem. Veja installCommand.

Maximum string length: 500
root
string

No site php sem command: a pasta que a Cube serve (sem ela, a public quando existe, senão a raiz). No static: a pasta servida, como dist ("" = a raiz). Sem ela, a pasta do index.html mais raso do .zip (a raiz, ou dist quando ele só existe lá). Sem .. nem pasta que começa com ponto.

Maximum string length: 200
systemPackages
string

Pacotes do sistema, em JSON: ["poppler-utils"]. Sem ele, valem os systemPackages do cube.json (também quando o formulário traz language e command). Nome fora da lista, 422 unsupported_system_package.

databaseId
string

Liga o projeto a um banco de dados da conta: a string de conexão entra como variável de ambiente antes da primeira subida.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
databaseVariable
string

O nome da variável com a conexão. Sem ele, o sugerido do banco: DATABASE_URL (PostgreSQL e MySQL), MONGODB_URI ou REDIS_URL.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$

Resposta

Projeto criado, instalando as dependências.

project
object
obrigatório

Um projeto: um bot ou um site.

missingVariables
string[]
obrigatório

Com template: as variáveis obrigatórias dele que não vieram. Com alguma, o projeto instala e não inicia. Vazia sem template.

hints
object[]

Com file: o que a análise do envio avisa (o compilado no lugar do código-fonte, as pastas que saíram por serem geradas no build). Vazia quando não há nada a avisar.