Os endpoints de consulta mostram usuários e domínios do servidor: situação, versão do PHP, cota, certificado SSL, document root e variáveis de ambiente. Funcionam com o token de leitura ou com o de escrita.
Nos exemplos abaixo:
MINICP=https://painel.exemplo.com.br:5000
TOKEN=seu_token
Endpoints
| Método e caminho | O que devolve |
|---|---|
GET /api/v1/users |
Lista de usuários. |
GET /api/v1/users/<usuario> |
Um usuário, com os domínios detalhados. |
GET /api/v1/domains |
Lista de domínios. |
GET /api/v1/domains/<dominio> |
Um domínio. Aceita também um alias. |
GET /api/v1/domains/<dominio>/haproxy |
Situação do domínio no HAProxy. Veja API: publicar domínios no HAProxy. |
GET /api/v1/jobs/<id> |
Andamento de um provisionamento em segundo plano. |
Listar usuários
curl -s -H "Authorization: Bearer $TOKEN" "$MINICP/api/v1/users?status=active"
Filtro opcional status: active ou suspended.
Exemplo de resposta:
{
"ok": true,
"server": "web01",
"panel_version": "2.63.2",
"generated": "2026-11-18T14:05:00",
"count": 1,
"users": [
{
"username": "loja",
"status": "active",
"home": "/home/loja",
"quota": { "limit_mb": 10240, "used_mb": 3120, "used_pct": 30.5 },
"php_versions": ["8.3"],
"domains_total": 2,
"domains_inactive": 0,
"domains": ["loja.com.br", "blog.loja.com.br"]
}
]
}
Campos do usuário:
| Campo | Significado |
|---|---|
status |
active ou suspended. |
home |
Diretório da conta. |
quota.limit_mb |
Limite de espaço. null = sem limite. |
quota.used_mb |
Espaço usado. null = cota desligada no servidor. |
quota.used_pct |
Percentual usado, quando há limite. |
php_versions |
Versões de PHP usadas pelos domínios PHP da conta. |
domains_total / domains_inactive |
Total de domínios e quantos estão desativados. |
domains |
Nomes dos domínios. |
Consultar um usuário
curl -s -H "Authorization: Bearer $TOKEN" "$MINICP/api/v1/users/loja"
Devolve o campo user com os mesmos dados da lista. A diferença: domains traz cada domínio completo, no formato da seção abaixo. Usuário inexistente responde 404.
Listar domínios
curl -s -H "Authorization: Bearer $TOKEN" "$MINICP/api/v1/domains?user=loja&ssl=expiring"
Filtros opcionais (podem ser combinados):
| Filtro | Valores |
|---|---|
user |
Nome do usuário dono. |
status |
active ou inactive. |
ssl |
valid, expiring, expired ou none. |
Consultar um domínio
curl -s -H "Authorization: Bearer $TOKEN" "$MINICP/api/v1/domains/loja.com.br"
Pode informar um alias (por exemplo www.loja.com.br): a resposta traz o domínio principal.
Resposta com o token de leitura:
{
"ok": true,
"server": "web01",
"panel_version": "2.66.0",
"generated": "2026-11-18T14:06:00",
"domain": {
"domain": "loja.com.br",
"aliases": ["www.loja.com.br"],
"username": "loja",
"status": "active",
"user_suspended": false,
"type": "php",
"php_version": "8.3",
"document_root": "/home/loja/public_html",
"redirect_to": null,
"env": { "MAGE_RUN_CODE": null, "MAGE_RUN_TYPE": null },
"ssl": {
"status": "valid",
"expires": "2027-01-20",
"days_left": 63,
"issuer": "Let's Encrypt",
"source": "haproxy"
}
}
}
Com o token de escrita, o mesmo GET traz os valores: "env": { "MAGE_RUN_CODE": "base", "MAGE_RUN_TYPE": "website" }.
Campos do domínio:
| Campo | Significado |
|---|---|
aliases |
Outros nomes atendidos pelo mesmo site. |
status |
active ou inactive (site desativado mostra a página de site inativo). |
user_suspended |
true se a conta dona está suspensa. |
type |
php, node ou redirect. |
php_version |
Só para php. |
document_root |
Só para php. |
redirect_to |
Só para redirect: URL de destino. |
env |
Variáveis de ambiente do domínio, como objeto ({} se não houver). Com o token de leitura, só os nomes, cada um com valor null; com o token de escrita, {"CHAVE": "valor"}. null para node e redirect. Para alterar, veja API: criar, editar e remover domínios. |
ssl.status |
valid, expiring (15 dias ou menos), expired, none (sem certificado) ou unknown. |
ssl.expires / ssl.days_left |
Validade do certificado. |
ssl.issuer / ssl.source |
Emissor e onde o certificado foi encontrado. |
O campo env aparece também na listagem de domínios e nos domínios detalhados de GET /api/v1/users/<usuario>, com a mesma regra de leitura e escrita.
Atenção: o token de leitura não vê os valores de
env, mas o token de escrita vê. Mesmo assim, evite guardar senhas nas variáveis de ambiente do domínio.
Dica: a situação do certificado é atualizada a cada 5 minutos. Logo depois de emitir um certificado, a consulta pode levar alguns minutos para mostrar
valid.
Domínio inexistente responde 404 com dominio nao encontrado.