Utilizar a API do DirectAdmin: gerir o seu pacote com scripts

O DirectAdmin tem uma API: uma forma de gerir o seu pacote com um script ou programa em vez de com o rato. Quase tudo o que faz no painel também pode ser feito através da API. Pense em atualizar um registo DNS quando o seu endereço IP em casa muda, criar caixas de correio a partir do seu próprio software ou consultar todas as noites uma lista das suas bases de dados.

Posso utilizar a API com o meu pacote?

Sim. A API funciona com qualquer pacote que inclua o DirectAdmin: todos os pacotes de alojamento web e também os pacotes de e-mail. Os revendedores podem, além disso, utilizá-la para gerir as contas dos seus próprios clientes. Não precisa de pedir nada e não tem custos adicionais.

Um script tem exatamente os mesmos direitos que você no DirectAdmin. Por isso, só pode aceder ao seu próprio pacote e apenas às funcionalidades que o seu pacote permite.

Como funciona

• Endereço: comunica com a API no mesmo local onde inicia sessão: https://nomedoservidor:2222. Pode encontrar o nome do seu servidor em O meu WebOké, junto ao pacote, em Gerir.
• Dois tipos de comandos: a nova API, com endereços que começam com /api/ e respostas em JSON, e a API mais antiga, com comandos como /CMD_API_.... Comece pela nova API. O que ainda não esteja incluído aí, encontra na API antiga. Adicione ?json=yes no final para obter uma resposta em JSON.
• Iniciar sessão: cada comando envia o seu nome de utilizador DA e uma palavra-passe (autenticação HTTP Basic). Para isso, utilize preferencialmente uma chave de acesso (login key) e não a sua palavra-passe DA real, veja abaixo.
• Documentação no seu próprio painel: no DirectAdmin, encontra em Support & Help a API Documentation. Aí vê todos os comandos da nova API e pode testá-los de imediato com a sua própria conta.

Um exemplo

Com este comando pede as bases de dados do seu pacote. Substitua utilizador, chave e nomedoservidor pelos seus próprios dados:

curl -u 'utilizador:chave' https://nomedoservidor:2222/api/db-show/databases

Recebe uma lista em JSON como resposta. Funciona da mesma forma a partir de PHP, Python ou qualquer outra linguagem capaz de consultar um endereço web.

Trabalhar em segurança com uma chave de acesso

Nunca dê a um script a sua palavra-passe DA normal. Crie no DirectAdmin, em Chaves de acesso, uma chave separada. Pode limitar essa chave a:

• apenas os comandos que o script realmente precisa;
• apenas a partir do endereço IP do computador ou servidor onde o script é executado;
• com uma data de validade, se apenas precisar do acesso temporariamente.

Exclua sempre os comandos CMD_LOGIN_KEYS e CMD_PASSWD, para que a chave não possa criar novas chaves nem alterar a sua palavra-passe. Se a chave for comprometida, basta eliminá-la e criar uma nova, sem precisar de alterar a sua palavra-passe.

Encontra o passo a passo para criar uma chave na documentação do DirectAdmin: Chaves de acesso: iniciar sessão para scripts e programas.

Bom saber

• Se um script tentar várias vezes iniciar sessão com uma palavra-passe ou chave incorreta, a nossa firewall bloqueia esse endereço IP. Consulte Estou bloqueado? se o seu script deixar subitamente de conseguir ligar-se.
• Ajudamos com todo o gosto se a própria API não funcionar, mas não escrevemos nem verificamos scripts próprios. Para isso, consulte a documentação do DirectAdmin abaixo.
• Prefere gerir o seu alojamento com o Claude, ChatGPT ou Mistral, sem programar você mesmo? Consulte então o nosso Servidor MCP para IA.

Documentação do DirectAdmin

A documentação do DirectAdmin está em inglês:

• API Access: como funciona a API, iniciar sessão e os diferentes tipos de API.
• Examples: exemplos com curl, Bash, PHP e Python.
• Legacy API: os comandos CMD_API mais antigos e as respetivas respostas.
• Overview of CMD_API commands: pesquisar em todos os comandos mais antigos.
• Creating a login key: chaves de acesso segundo o DirectAdmin.

Consulte também na documentação do DirectAdmin: Encontrar o nome do seu servidor e o nome de utilizador DA.