Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.vmarea.com/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Crie um token de API

1

Acesse o painel

Entre em vmarea.com/dashboard e navegue até Configurações → API Keys.
2

Crie a chave

Clique em New API Key, dê um nome descritivo, selecione os escopos necessários e, opcionalmente, defina uma data de validade.
3

Salve o segredo

O segredo é exibido apenas uma vez. Copie-o imediatamente e armazene em uma variável de ambiente ou gerenciador de segredos.
export VMAREA_TOKEN="vmk_..."
Consulte Escopos e permissões para a lista completa de escopos disponíveis.

​
2. Liste planos e regiões disponíveis

Antes de criar uma VM, consulte o catálogo para encontrar um planId, regionId e osTemplateId válidos. Leituras do catálogo não exigem nenhum escopo específico — qualquer token válido funciona. 
curl https://api.vmarea.com/api/public/v1/plans \
  -H "x-api-key: $VMAREA_TOKEN"

​
3. Crie uma VM

curl -X POST https://api.vmarea.com/api/public/v1/vms \
  -H "x-api-key: $VMAREA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-server",
    "hostname": "my-server",
    "planId": "<plan-id>",
    "regionId": "<region-id>",
    "osTemplateId": "<os-template-id>"
  }'
Uma resposta bem-sucedida retorna 201 com { success: true, data: { id, status, ... } }. O provisionamento começa imediatamente.

​
4. Aguarde o status

A criação de VM é assíncrona. Faça polling até que status chegue a RUNNING (ou FAILED): 
curl https://api.vmarea.com/api/public/v1/vms/<vm-id> \
  -H "x-api-key: $VMAREA_TOKEN"
Outra opção é assinar um webhook para vm.created e eliminar o polling por completo.

​
5. Ações de ciclo de vida

Com a VM em execução, controle-a com os endpoints de ação: 
# Iniciar
curl -X POST https://api.vmarea.com/api/public/v1/vms/<vm-id>/start \
  -H "x-api-key: $VMAREA_TOKEN"

# Parar
curl -X POST https://api.vmarea.com/api/public/v1/vms/<vm-id>/stop \
  -H "x-api-key: $VMAREA_TOKEN"

# Reiniciar
curl -X POST https://api.vmarea.com/api/public/v1/vms/<vm-id>/restart \
  -H "x-api-key: $VMAREA_TOKEN"
Todas as ações de ciclo de vida exigem o escopo vms:write.

​
Próximos passos

Referência da API

Surface completa: regras de firewall, redes privadas, chaves SSH, backups, snapshots e endpoints de faturamento.

Escopos e permissões

Entenda quais escopos cada operação exige.