> ## 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
> O nome interno, a porta e a senha do Lavalink da sua conta, para o seu bot conectar.
Para o projeto de um template com conexão, hoje o [Lavalink](/hosting/lavalink): devolve o **nome interno** do projeto (o mesmo `internalHost` de [Ver um projeto](/api-reference/projects/get)), a porta e a **senha** que a Cube gerou na variável `LAVALINK_SERVER_PASSWORD`. Com a variável apagada, `password` vem `null`.
Esses dados só funcionam de dentro da sua conta: ponha a senha numa [variável de ambiente](/api-reference/projects/set-variables) do seu bot, nunca no código.
Como a conexão de um banco, esta rota pede uma chave de **leitura e escrita**, responde sem cache e cada leitura aparece na [Atividade](https://app.cubehosting.com.br/activity), sem a senha.
## Erros comuns
| Código | HTTP | O que fazer |
| - | - | - |
| [`insufficient_permission`](/errors#param-insufficient-permission) | 403 | Use uma chave de leitura e escrita. |
| [`not_found`](/errors#param-not-found) | 404 | Confira o ID. O projeto precisa ser de um template com conexão (o Lavalink); trocado por outro `.zip`, ele deixa de ser. |
Todos os códigos, com o formato do erro, em [Códigos de erro](/errors).
## OpenAPI
````yaml GET /projects/{id}/connection
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, veja a análise das visitas dos
sites, 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, use um domínio seu nos sites 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: Análise
- name: Variáveis de ambiente
- name: Backups
- name: Versões dos envios
- name: Bancos de dados
- name: Blob
- name: Domínios
- name: Templates
- name: Avisos
- name: Conta
paths:
/projects/{id}/connection:
get:
tags:
- Variáveis de ambiente
summary: Ver a conexão
description: >-
Para o projeto de um template com conexão (o
[Lavalink](/hosting/lavalink)): o **nome interno**, a porta e a
**senha** que a Cube gerou (`null` se a variável dela foi apagada). 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, sem
a senha. Os dados só funcionam de dentro da conta: ponha a senha numa
[variável de ambiente](/api-reference/projects/set-variables) do seu
bot. Projeto de outro template, ou que deixou de ser do template,
responde `404`.
operationId: getProjectConnection
parameters:
- $ref: '#/components/parameters/ProjectId'
responses:
'200':
description: 'A conexão. Resposta com `Cache-Control: no-store`.'
content:
application/json:
schema:
type: object
required:
- connection
properties:
connection:
type: object
required:
- host
- port
- password
properties:
host:
type: string
description: O `internalHost` do projeto.
port:
type: integer
password:
type:
- string
- 'null'
description: >-
A senha da variável do template; `null` se ela foi
apagada.
example:
connection:
host: cube-t9d1h3xa
port: 2333
password: Xk3v9QmZ-2bLr7_hP4sN8wTyC1dFgJ6a
'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, baixar e restaurar
backups, baixar e voltar versões dos envios, criar, ligar,
desligar, fazer backup 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 projeto não existe ou não é da sua conta.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not_found:
summary: not_found
value:
status: error
code: not_found
message: Projeto 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/projects/$PROJECT_ID/connection \
-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}/projects/${process.env.PROJECT_ID}/connection`, {
headers });
const { connection } = await res.json();
console.log(connection.host, connection.port); // guarde a senha
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}/projects/{os.environ['PROJECT_ID']}/connection", headers=headers, timeout=30
)
r.raise_for_status()
c = r.json()["connection"]
print(c["host"], c["port"])
components:
parameters:
ProjectId:
name: id
in: path
required: true
description: >-
O ID do projeto (26 caracteres). Aparece no painel, no topo do projeto,
e em `GET /projects`.
schema:
type: string
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
example: 01J8Z3W6N0Q4Y7V2K5T9D1H3XA
schemas:
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_…`.
````