API do Virtualizor: conta Cloud, cota e cobrança

Endpoints da própria conta de revenda: quanto da cota já foi usado, o extrato de cobrança, os dados de perfil, as preferências do painel, a senha de acesso e os alertas do sistema.

Antes de começar, veja API do Virtualizor para revendedores: primeiros passos: lá estão a chave de API, o formato da chamada e as funções virt_api usadas nos exemplos em PHP, Python e Node.js.

Neste artigo

1. Ver a cota e o uso da conta Cloud — act=cloudres
2. Ver saldo, faturas e consumo (cobrança do Virtualizor) — act=billing
3. Alterar nome e sobrenome do perfil — act=profile
4. Alterar idioma, tema e fuso horário do painel — act=usersettings
5. Trocar a senha da conta — act=userpassword
6. Ver os alertas de uma VPS — act=system_alerts

Ver a cota e o uso da conta Cloud

Ação: act=cloudres · Método: GET · Exclusivo do usuário Cloud

Mostra os recursos que a sua conta de revenda tem direito a usar e quanto já está em uso. É a primeira chamada a fazer antes de criar uma VPS: se a cota acabou, a criação falha.

Parâmetros

Nenhum além da ação e da autenticação.

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=cloudres&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS"

PHP

$r = virt_api('cloudres');
print_r($r);

Python

r = virt_api("cloudres")
print(r)

Node.js

const r = await virtApi('cloudres');
console.log(r);

Resposta

resources traz a cota contratada: número de VPS (num_vs), de usuários (num_users), disco (space), RAM (ram, em MB), banda (bandwidth), IPv4 (num_ipv4), IPv6 (num_ipv6, num_ipv6_subnet), núcleos (num_cores) e as virtualizações permitidas (allowed_virts). usage traz o que já foi consumido, e users lista os clientes da conta.

Cuidados

• A diferença entre resources e usage é o que ainda dá para alocar. Faça a conta antes de chamar a criação de VPS.
• A tabela da documentação oficial lista act como parâmetro POST; o exemplo dela, e o deste artigo, mandam tudo pela URL, sem corpo.

Documentação oficial: Cloud Resources.

Ver saldo, faturas e consumo (cobrança do Virtualizor)

Ação: act=billing · Método: GET · Exclusivo do usuário Cloud

Devolve o saldo, as faturas, as transações e o consumo por hora da conta, quando a cobrança interna do próprio Virtualizor está ligada.

Parâmetros

Nenhum além da ação e da autenticação.

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=billing&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS"

PHP

$r = virt_api('billing');
print_r($r);

Python

r = virt_api("billing")
print(r)

Node.js

const r = await virtApi('billing');
console.log(r);

Resposta

balance (saldo), cur_usage (consumo do período), invoices (faturas, com número, data, vencimento, valor e situação), transactions (pagamentos e créditos) e usage (consumo por recurso e por VPS). O campo inhouse_billing diz se a cobrança interna do Virtualizor está ligada.

Cuidados

• A mensalidade da revenda na Vitt Host é cobrada pela central do cliente, não por este módulo. Se inhouse_billing vier desligado, os campos de fatura vêm vazios, e isso é o esperado.

Documentação oficial: Cloud Billing.

Alterar nome e sobrenome do perfil

Ação: act=profile · Método: POST

Atualiza o nome e o sobrenome da conta que está chamando a API.

Parâmetros

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=profile&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS" \
  --data-urlencode 'savedetails=1' \
  --data-urlencode 'fname=Maria' \
  --data-urlencode 'lname=Souza'

PHP

$r = virt_api('profile', [], [
    'savedetails' => '1',
    'fname' => 'Maria',
    'lname' => 'Souza',
]);
print_r($r);

Python

r = virt_api("profile", post={
    "savedetails": "1",
    "fname": "Maria",
    "lname": "Souza",
})
print(r)

Node.js

const r = await virtApi('profile', {}, {
  savedetails: '1',
  fname: 'Maria',
  lname: 'Souza',
});
console.log(r);

Resposta

done indica que o perfil foi gravado. preferences traz os dados já atualizados.

Documentação oficial: Profile.

Alterar idioma, tema e fuso horário do painel

Ação: act=usersettings · Método: POST

Muda as preferências do painel da conta: idioma, tema (skin) e fuso horário. Sem editsettings, a chamada devolve as opções disponíveis.

Parâmetros

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=usersettings&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS" \
  --data-urlencode 'editsettings=1' \
  --data-urlencode 'language=english' \
  --data-urlencode 'skins=default' \
  --data-urlencode 'timezone=-3'

PHP

$r = virt_api('usersettings', [], [
    'editsettings' => '1',
    'language' => 'english',
    'skins' => 'default',
    'timezone' => '-3',
]);
print_r($r);

Python

r = virt_api("usersettings", post={
    "editsettings": "1",
    "language": "english",
    "skins": "default",
    "timezone": "-3",
})
print(r)

Node.js

const r = await virtApi('usersettings', {}, {
  editsettings: '1',
  language: 'english',
  skins: 'default',
  timezone: '-3',
});
console.log(r);

Resposta

done confirma a gravação. Numa chamada sem editsettings, skins, languages, timezones e timezone_names trazem as opções aceitas.

Cuidados

• O exemplo em PHP da documentação oficial manda o nome do fuso por extenso no campo timezone; a tabela e o exemplo em curl mandam o número. Use o número.

Documentação oficial: User Settings.

Trocar a senha da conta

Ação: act=userpassword · Método: POST

Troca a senha de acesso ao painel da conta que está chamando a API. Não mexe na senha de root de nenhuma VPS.

Parâmetros

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=userpassword&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS" \
  --data-urlencode 'changepass=1' \
  --data-urlencode 'newpass=Nova-Senha-Forte-2026' \
  --data-urlencode 'conf=Nova-Senha-Forte-2026'

PHP

$r = virt_api('userpassword', [], [
    'changepass' => '1',
    'newpass' => 'Nova-Senha-Forte-2026',
    'conf' => 'Nova-Senha-Forte-2026',
]);
print_r($r);

Python

r = virt_api("userpassword", post={
    "changepass": "1",
    "newpass": "Nova-Senha-Forte-2026",
    "conf": "Nova-Senha-Forte-2026",
})
print(r)

Node.js

const r = await virtApi('userpassword', {}, {
  changepass: '1',
  newpass: 'Nova-Senha-Forte-2026',
  conf: 'Nova-Senha-Forte-2026',
});
console.log(r);

Resposta

done indica que a senha foi trocada.

Cuidados

• A tabela da documentação oficial chama a confirmação de confirm; os exemplos dela, em PHP e em curl, usam conf. Este artigo segue os exemplos.

Documentação oficial: Account Password.

Ver os alertas de uma VPS

Ação: act=system_alerts · Método: GET

Lista os alertas registrados para uma VPS, com os valores de CPU, RAM e disco no momento de cada um.

Parâmetros

Exemplos

curl

curl -sS "https://$VIRT_HOST:4083/index.php?act=system_alerts&svs=101&api=json&apikey=$VIRT_KEY&apipass=$VIRT_PASS"

PHP

$r = virt_api('system_alerts', [
    'svs' => '101',
]);
print_r($r);

Python

r = virt_api("system_alerts", get={
    "svs": "101",
})
print(r)

Node.js

const r = await virtApi('system_alerts', {
  svs: '101',
});
console.log(r);

Resposta

alerts traz a lista, com a hora (time) e os valores de cpu, ram e disk no momento do alerta. num_res é a quantidade.

Cuidados

• A documentação oficial também lista o id da VPS como vid no corpo; o exemplo dela usa só svs na URL, como aqui.

Documentação oficial: System Alerts.

Texto da Vitt Host, escrito a partir da documentação oficial da Virtualizor, lida em 07/10/2026. Onde a documentação oficial se contradiz, o artigo segue os exemplos dela e aponta a diferença em Cuidados.