Obter banco de dados pelo ID
curl --request GET \
--url https://api.vertracloud.app/v1/databases/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/databases/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/databases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/databases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": {
"id": "00000000000000000000000000000001",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "123456789012345678",
"owner_plan": "pro",
"status": "up",
"ram": 256,
"host": "database.example.com",
"port": 6379,
"username": "vertracloud",
"version": "8.2",
"offline_since": null,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
Bancos de dados
Obter banco de dados pelo ID
Retorna os detalhes de um banco de dados específico pelo seu ID.
GET
/
v1
/
databases
/
{id}
Obter banco de dados pelo ID
curl --request GET \
--url https://api.vertracloud.app/v1/databases/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/databases/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/databases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/databases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": {
"id": "00000000000000000000000000000001",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "123456789012345678",
"owner_plan": "pro",
"status": "up",
"ram": 256,
"host": "database.example.com",
"port": 6379,
"username": "vertracloud",
"version": "8.2",
"offline_since": null,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
string
obrigatório
O ID do banco de dados a obter. Se o banco de dados pertencer a um workspace, informe o ID dele no parâmetro de query
workspace_id.string
Se o banco de dados pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam sobre um banco de dados que não lhes pertence.
Resposta
object
Os detalhes do banco de dados.
Mostrar Mostrar objeto
Mostrar Mostrar objeto
string
O ID do banco de dados.
number
O ID do cluster do banco de dados.
number
O tipo do banco de dados.
string
O nome do banco de dados.
string
A descrição do banco de dados.
string
O ID do dono do banco de dados.
string | null
O nome do plano do dono (por exemplo,
pro ou enterprise-8), ou null quando o dono não tem plano.string
O status do banco de dados (por exemplo,
up).number
A RAM alocada ao banco de dados, em MB.
string
O endereço do host do banco de dados.
number
A porta usada pelo banco de dados.
string
O usuário para conectar. Bancos de dados criados a partir da v26.4.8 usam
vertracloud (banco padrão vertracloud, sem ser superusuário); bancos de dados mais antigos mantêm o usuário do motor (postgres, default ou root).string
A versão major do motor, por exemplo
"18" ou "8.0". Atualizações de segurança são aplicadas no restart sem alterá-la.string | null
O ID da stack à qual o banco de dados pertence, ou
null quando ele não está em uma stack.string | null
O ID do serviço do template em que este banco de dados está dentro da stack, ou
null quando você o adicionou por conta própria.string
A data e hora em que o banco de dados foi criado.
string
A data e hora em que o banco de dados foi atualizado pela última vez.
string | null
A data e hora em que o banco de dados ficou offline, se aplicável.
string | null
A data e hora do último snapshot, se disponível.
{
"response": {
"id": "00000000000000000000000000000001",
"cluster": 1,
"type": 3,
"name": "MyDatabase",
"description": "I have a description :)",
"owner_id": "123456789012345678",
"owner_plan": "pro",
"status": "up",
"ram": 256,
"host": "database.example.com",
"port": 6379,
"username": "vertracloud",
"version": "8.2",
"offline_since": null,
"last_snapshot": "2026-03-14T19:58:00Z",
"created_at": "2026-03-14T19:58:00Z",
"updated_at": "2026-03-14T19:58:00Z"
}
}
Respostas de erro
string
O código de erro que indica o motivo da falha. Valores possíveis:
AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: O headerAuthorizationestá ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).API_KEY_IP_DENIED,API_KEY_SCOPE_DENIED: A chave de API é usada a partir de um IP fora da sua lista de IPs permitidos, ou não tem o escopo que a rota exige (403).ACCESS_DENIED: O recurso pertence a outra conta, ou você não tem a permissão de workspace para ele (403).DATABASE_NOT_FOUND: O banco de dados informado não existe ou o usuário não tem acesso.
string
Uma mensagem descritiva com detalhes adicionais sobre o erro.
{
"code": "ACCESS_DENIED"
}
{
"code": "DATABASE_NOT_FOUND"
}
Última modificação em 28 de outubro de 2026