Listar bancos de dados

curl

curl https://app.cubehosting.com.br/api/databases \
  -H "Authorization: Bearer $CUBE_API_KEY"

const API = 'https://app.cubehosting.com.br/api';
const headers = { Authorization: `Bearer ${process.env.CUBE_API_KEY}` };

const res = await fetch(`${API}/databases`, { headers });
const { databases, limit } = await res.json();
for (const d of databases) console.log(d.name, d.engineName, d.status, `${d.host}:${d.port}`);
console.log(`${databases.length} de ${limit}`);

import os
import requests

API = "https://app.cubehosting.com.br/api"
headers = {"Authorization": f"Bearer {os.environ['CUBE_API_KEY']}"}

r = requests.get(f"{API}/databases", headers=headers, timeout=30)
r.raise_for_status()
for d in r.json()["databases"]:
    print(d["name"], d["status"], f"{d['host']}:{d['port']}")

{
  "databases": [
    {
      "id": "01J9A2C4E6G8J0K2M4P6R8T0V2",
      "name": "loja-db",
      "engine": "postgres",
      "engineName": "PostgreSQL",
      "host": "loja-db",
      "port": 5432,
      "status": "running",
      "memoryMb": 512,
      "usage": {
        "memoryMb": 61
      },
      "disk": {
        "usedMb": 47,
        "limitMb": 2048
      },
      "startedAt": "2026-09-28T12:26:03.000Z",
      "createdAt": "2026-09-28T12:26:00.000Z",
      "updatedAt": "2026-09-28T12:26:01.000Z"
    }
  ],
  "limit": 3,
  "freeMemoryMb": 3072,
  "diskMb": 2048,
  "backupRetentionDays": 7,
  "engines": [
    {
      "id": "postgres",
      "name": "PostgreSQL",
      "port": 5432,
      "minMemoryMb": 512,
      "isAvailable": true
    },
    {
      "id": "mysql",
      "name": "MySQL",
      "port": 3306,
      "minMemoryMb": 512,
      "isAvailable": true
    },
    {
      "id": "mongodb",
      "name": "MongoDB",
      "port": 27017,
      "minMemoryMb": 512,
      "isAvailable": false
    },
    {
      "id": "redis",
      "name": "Redis",
      "port": 6379,
      "minMemoryMb": 256,
      "isAvailable": true
    }
  ]
}

GET

databases

curl

curl https://app.cubehosting.com.br/api/databases \
  -H "Authorization: Bearer $CUBE_API_KEY"

const API = 'https://app.cubehosting.com.br/api';
const headers = { Authorization: `Bearer ${process.env.CUBE_API_KEY}` };

const res = await fetch(`${API}/databases`, { headers });
const { databases, limit } = await res.json();
for (const d of databases) console.log(d.name, d.engineName, d.status, `${d.host}:${d.port}`);
console.log(`${databases.length} de ${limit}`);

import os
import requests

API = "https://app.cubehosting.com.br/api"
headers = {"Authorization": f"Bearer {os.environ['CUBE_API_KEY']}"}

r = requests.get(f"{API}/databases", headers=headers, timeout=30)
r.raise_for_status()
for d in r.json()["databases"]:
    print(d["name"], d["status"], f"{d['host']}:{d['port']}")

{
  "databases": [
    {
      "id": "01J9A2C4E6G8J0K2M4P6R8T0V2",
      "name": "loja-db",
      "engine": "postgres",
      "engineName": "PostgreSQL",
      "host": "loja-db",
      "port": 5432,
      "status": "running",
      "memoryMb": 512,
      "usage": {
        "memoryMb": 61
      },
      "disk": {
        "usedMb": 47,
        "limitMb": 2048
      },
      "startedAt": "2026-09-28T12:26:03.000Z",
      "createdAt": "2026-09-28T12:26:00.000Z",
      "updatedAt": "2026-09-28T12:26:01.000Z"
    }
  ],
  "limit": 3,
  "freeMemoryMb": 3072,
  "diskMb": 2048,
  "backupRetentionDays": 7,
  "engines": [
    {
      "id": "postgres",
      "name": "PostgreSQL",
      "port": 5432,
      "minMemoryMb": 512,
      "isAvailable": true
    },
    {
      "id": "mysql",
      "name": "MySQL",
      "port": 3306,
      "minMemoryMb": 512,
      "isAvailable": true
    },
    {
      "id": "mongodb",
      "name": "MongoDB",
      "port": 27017,
      "minMemoryMb": 512,
      "isAvailable": false
    },
    {
      "id": "redis",
      "name": "Redis",
      "port": 6379,
      "minMemoryMb": 256,
      "isAvailable": true
    }
  ]
}

Devolve os bancos da conta, do mais novo para o mais antigo, e as regras do plano: quantos bancos cabem (limit), a memória que sobra somando projetos e bancos (freeMemoryMb) e os tipos de banco com a memória mínima de cada um (engines). Funciona com a chave de leitura. Guia completo em Bancos de dados.

O host e a port de cada banco são o endereço que os projetos da sua conta usam, como loja-db:5432. A senha só vem em Ver a conexão.

Erros comuns

Código	HTTP	O que fazer
`invalid_api_key`	401	Confira o cabeçalho `Authorization: Bearer cube_…` ou crie outra chave.
`rate_limit_exceeded`	429	Espere o `Retry-After`: a conta passou do limite do plano.

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_….

Resposta

Os bancos e as regras do plano.

databases

object[]

obrigatório

Do mais novo para o mais antigo.

Show child attributes

limit

integer | null

obrigatório

Quantos bancos o plano permite (0 no Free e no Block, Stack 1, Tower 3, Fortress 6, Monolith 12; null = sob medida).

freeMemoryMb

integer | null

obrigatório

A memória do plano que sobra, somando projetos e bancos.

diskMb

integer

obrigatório

Espaço de cada banco, em MB.

backupRetentionDays

integer

obrigatório

Por quantos dias o backup diário fica guardado (7).

engines

object[]

obrigatório

Show child attributes

Visão geral

Projetos

Controle

Logs e métricas

Variáveis de ambiente

Backups

Versões dos envios

Bancos de dados

Blob

Avisos

Conta

Erros comuns

Autorizações

Resposta

​Erros comuns

Autorizações

Resposta

Erros comuns