Ver a conexão

curl

curl https://app.cubehosting.com.br/api/databases/$DATABASE_ID/credentials \
  -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/${process.env.DATABASE_ID}/credentials`, { headers });
const { credentials } = await res.json();
console.log(credentials.envName); // DATABASE_URL (guarde a url como segredo)

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/{os.environ['DATABASE_ID']}/credentials", headers=headers, timeout=30)
r.raise_for_status()
c = r.json()["credentials"]
print(c["envName"], c["host"], c["port"])

{
  "credentials": {
    "host": "loja-db",
    "port": 5432,
    "username": "cube",
    "password": "q9Zk3Lr_TbW7vXe2Hn5yP-aD1sUcFo8M",
    "database": "loja_db",
    "url": "postgresql://cube:q9Zk3Lr_TbW7vXe2Hn5yP-aD1sUcFo8M@loja-db:5432/loja_db",
    "envName": "DATABASE_URL"
  }
}

GET

databases

{id}

credentials

curl

curl https://app.cubehosting.com.br/api/databases/$DATABASE_ID/credentials \
  -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/${process.env.DATABASE_ID}/credentials`, { headers });
const { credentials } = await res.json();
console.log(credentials.envName); // DATABASE_URL (guarde a url como segredo)

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/{os.environ['DATABASE_ID']}/credentials", headers=headers, timeout=30)
r.raise_for_status()
c = r.json()["credentials"]
print(c["envName"], c["host"], c["port"])

{
  "credentials": {
    "host": "loja-db",
    "port": 5432,
    "username": "cube",
    "password": "q9Zk3Lr_TbW7vXe2Hn5yP-aD1sUcFo8M",
    "database": "loja_db",
    "url": "postgresql://cube:q9Zk3Lr_TbW7vXe2Hn5yP-aD1sUcFo8M@loja-db:5432/loja_db",
    "envName": "DATABASE_URL"
  }
}

Devolve tudo para conectar: host, port, username, password, database e a url pronta, com o nome de variável sugerido em envName (DATABASE_URL, MONGODB_URI ou REDIS_URL). Só a chave de leitura e escrita vê a senha, e cada leitura fica registrada na Atividade da conta. A conexão só funciona de dentro da sua conta. Para ligar o banco a um projeto, ponha a url numa variável de ambiente dele, ou crie o projeto já ligado com databaseId em Criar um projeto.

A url traz a senha. Guarde-a como segredo: numa variável de ambiente ou no gerenciador de segredos do seu CI, nunca no código.

Erros comuns

Código	HTTP	O que fazer
`insufficient_permission`	403	A chave de leitura não vê senhas: use uma de leitura e escrita.
`not_found`	404	O banco não existe ou não é da sua conta.

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

Parâmetros de caminho

string

obrigatório

O ID do banco de dados (26 caracteres), de Listar bancos de dados.

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

Exemplo:

"01J9A2C4E6G8J0K2M4P6R8T0V2"

Resposta

A conexão. Resposta com Cache-Control: no-store.

credentials

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

Parâmetros de caminho

Resposta

​Erros comuns

Autorizações

Parâmetros de caminho

Resposta

Erros comuns