Obter status do banco de dados pelo ID
curl --request GET \
--url https://api.vertracloud.app/v1/databases/{id}/status \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/databases/{id}/status', 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}/status"
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}/status"
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": "db-abc123def456",
"cpu": "12.30%",
"ram": "256.00 MB",
"storage": "512.00 MB",
"status": "running",
"running": true,
"network": {
"total": "320.15KB ↓ 20.10KB ↑",
"now": "5.00KB ↑ 1.00KB ↓"
},
"uptime": 7200,
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
}
Bancos de dados
Obter status do banco de dados pelo ID
Retorna o status atual e o uso de recursos de um banco de dados pelo seu ID.
GET
/
v1
/
databases
/
{id}
/
status
Obter status do banco de dados pelo ID
curl --request GET \
--url https://api.vertracloud.app/v1/databases/{id}/status \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/databases/{id}/status', 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}/status"
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}/status"
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": "db-abc123def456",
"cpu": "12.30%",
"ram": "256.00 MB",
"storage": "512.00 MB",
"status": "running",
"running": true,
"network": {
"total": "320.15KB ↓ 20.10KB ↑",
"now": "5.00KB ↑ 1.00KB ↓"
},
"uptime": 7200,
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
}
string
obrigatório
O ID do banco de dados do qual obter o status. 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.
Um banco de dados parado responde
200, não um erro. O container de um banco de dados parado não existe — ele é removido ao parar — e isso é um estado normal, não uma falha. A API retorna 200 com status: "stopped", running: false e todas as métricas zeradas. Só uma falha real ao ler o status retorna 500.Resposta
object
Os detalhes de status e de uso de recursos do banco de dados.
Mostrar Mostrar objeto
Mostrar Mostrar objeto
string
O ID do banco de dados.
string
Percentual de uso de CPU, já formatado (por exemplo,
12.30%).string
Uso de RAM, já formatado (por exemplo,
256.00 MB).string
Uso de armazenamento, já formatado (por exemplo,
512.00 MB).string
O status do banco de dados:
running ou stopped.boolean
Indica se o banco de dados está em execução no momento.
object
number
O tempo em execução do banco de dados, em segundos.
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.
{
"response": {
"id": "db-abc123def456",
"cpu": "12.30%",
"ram": "256.00 MB",
"storage": "512.00 MB",
"status": "running",
"running": true,
"network": {
"total": "320.15KB ↓ 20.10KB ↑",
"now": "5.00KB ↑ 1.00KB ↓"
},
"uptime": 7200,
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-11T15:06:41.449Z"
}
}
Respostas de erro
string
O código de erro que indica o motivo da falha. Valores possíveis:
DATABASE_NOT_FOUND: O banco de dados informado não existe.FORBIDDEN: O usuário não tem permissão para acessar o banco de dados.INTERNAL_SERVER_ERROR: Não foi possível ler o status. Um banco de dados parado não é esse caso — veja a nota acima.
string
Uma mensagem descritiva com detalhes adicionais sobre o erro.
{
"code": "DATABASE_NOT_FOUND"
}
{
"code": "FORBIDDEN"
}
{
"code": "INTERNAL_SERVER_ERROR"
}
Última modificação em 28 de outubro de 2026