Skip to main content

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.
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.

3. Crie uma VM

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):
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:
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.