> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cubehosting.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Ver a conexão
> Endereço, usuário, senha e a string de conexão pronta do banco.
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](/api-reference/projects/set-variables) dele, ou crie o projeto já ligado com `databaseId` em [Criar um projeto](/api-reference/projects/create).
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`](/errors#param-insufficient-permission) | 403 | A chave de leitura não vê senhas: use uma de leitura e escrita. |
| [`not_found`](/errors#param-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](/errors).
## OpenAPI
````yaml GET /databases/{id}/credentials
openapi: 3.1.0
info:
title: API da Cube Hosting
version: 1.0.0
description: >-
Hospede bots de Discord, sites e APIs em Node.js e Python: envie o .zip,
inicie, pare, reinicie, leia logs e métricas, cuide das variáveis de
ambiente, faça e baixe backups, volte para uma versão anterior, crie bancos
de dados (PostgreSQL, MySQL, MongoDB e Redis), guarde arquivos privados no
Blob e veja o uso do plano. Para agentes de IA, o servidor MCP da conta
(`POST https://app.cubehosting.com.br/api/mcp`, JSON-RPC, com a mesma chave)
está em https://docs.cubehosting.com.br/account-mcp.
contact:
name: Cube Hosting
url: https://discord.gg/pv6D9tUsDV
servers:
- url: https://app.cubehosting.com.br/api
security:
- bearerAuth: []
tags:
- name: Projetos
- name: Controle
- name: Logs e métricas
- name: Variáveis de ambiente
- name: Backups
- name: Versões dos envios
- name: Bancos de dados
- name: Blob
- name: Avisos
- name: Conta
paths:
/databases/{id}/credentials:
get:
tags:
- Bancos de dados
summary: Ver a conexão
description: >-
O endereço interno, a porta, o usuário, a **senha** e a string de
conexão pronta, com o nome de variável sugerido. Só com a chave de
**leitura e escrita** (a de leitura não vê a senha, como não vê os
valores das variáveis), e cada leitura entra na Atividade. A string só
funciona de dentro da conta: use-a numa [variável de
ambiente](/api-reference/projects/set-variables) de um projeto.
operationId: getDatabaseCredentials
parameters:
- $ref: '#/components/parameters/DatabaseId'
responses:
'200':
description: 'A conexão. Resposta com `Cache-Control: no-store`.'
content:
application/json:
schema:
type: object
required:
- credentials
properties:
credentials:
$ref: '#/components/schemas/DatabaseCredentials'
example:
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
'401':
description: Chave ausente, inválida ou revogada.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
invalid_api_key:
summary: invalid_api_key
value:
status: error
code: invalid_api_key
message: >-
Chave de API inválida ou revogada. Confira o cabeçalho
"Authorization: Bearer " ou crie outra em Chaves de
API no painel.
'403':
description: A chave é só de leitura.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
insufficient_permission:
summary: insufficient_permission
value:
status: error
code: insufficient_permission
message: >-
Esta chave é só de leitura. Para enviar, iniciar, parar,
reiniciar, mexer nas variáveis, fazer e baixar backups,
baixar e voltar versões dos envios, criar, ligar, desligar
e ver a senha dos bancos de dados ou enviar e apagar
arquivos do Blob, crie uma chave de leitura e escrita no
painel.
'404':
description: >-
O banco não existe ou não é da sua conta (a mesma resposta para os
dois).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not_found:
summary: not_found
value:
status: error
code: not_found
message: Banco de dados não encontrado.
'429':
description: Limite de pedidos. Traz o cabeçalho `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
rate_limit_exceeded:
summary: rate_limit_exceeded
value:
status: error
code: rate_limit_exceeded
message: >-
A sua conta passou do limite da API do plano Free: 10
pedidos por minuto. Espere 42 s e tente de novo.
too_many_attempts:
summary: too_many_attempts
value:
status: error
code: too_many_attempts
message: Muitas tentativas. Tente de novo em 15 minutos.
x-codeSamples:
- lang: bash
label: curl
source: >-
curl
https://app.cubehosting.com.br/api/databases/$DATABASE_ID/credentials
\
-H "Authorization: Bearer $CUBE_API_KEY"
- lang: javascript
label: Node.js
source: >-
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)
- lang: python
label: Python
source: >-
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"])
components:
parameters:
DatabaseId:
name: id
in: path
required: true
description: >-
O ID do banco de dados (26 caracteres), de [Listar bancos de
dados](/api-reference/databases/list).
schema:
type: string
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
example: 01J9A2C4E6G8J0K2M4P6R8T0V2
schemas:
DatabaseCredentials:
type: object
required:
- host
- port
- username
- password
- database
- url
- envName
properties:
host:
type: string
port:
type: integer
username:
type: string
description: '`cube` (`default` no Redis).'
password:
type: string
description: Gerada pela Cube (192 bits). Trate como segredo.
database:
type:
- string
- 'null'
description: >-
O banco dentro do servidor: o nome com `_` no lugar de `-`. `null`
no Redis.
url:
type: string
description: >-
A string de conexão pronta: `postgresql://…`, `mysql://…`,
`mongodb://…?authSource=admin` ou `redis://…`.
envName:
type: string
description: >-
O nome de variável sugerido: `DATABASE_URL`, `MONGODB_URI` ou
`REDIS_URL`.
Error:
type: object
required:
- status
- code
- message
properties:
status:
type: string
const: error
code:
type: string
description: Código fixo em inglês. Veja [Códigos de erro](/errors).
message:
type: string
description: Texto em português para mostrar a uma pessoa.
additionalProperties: true
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Chave de API da Cube (`cube_…`), criada no painel em **Chaves de API**.
Mande como `Authorization: Bearer cube_…`.
````