Nova Extensão para Plesk. Proteção Antivírus para melhorar a segurança do seu servidor. Porquê escolher o Flex Antivirus?

API — Programação Web

Utilitário Plesk - RPC — Pacotes XML

O protocolo API XML permite a interação remota entre o Plesk e aplicações de terceiros através de pacotes HTTP estruturados. Envie sua mensagem para o endpoint do Plesk, receba a resposta da operação e gerencie regras do firewall de forma programática sem acessar a interface web.

Windows Server API XML Plesk RPC HTTP/HTTPS

O que é a API XML RPC do Firewall Manager?

O protocolo API XML foi projetado para suportar a interação entre o Plesk e software de terceiros de forma remota. Para realizar uma operação, você deve enviar uma mensagem HTTP com uma estrutura específica para o endpoint do Plesk: https://<your-host-or-IP>:8443/enterprise/control/agent.php. O Plesk recebe a mensagem, transforma-a em instruções de operação, as executa e retorna os status e detalhes do resultado. Para mais informações sobre a estrutura dos pacotes e o transporte de mensagens, consulte Modelo Cliente-Servidor e Pacotes API XML.

Endpoint da API XML

POST https://<your-host-or-IP>:8443/enterprise/control/agent.php

Referência completa de pacotes CLI RPC


Comando Descrição dos Parâmetros Exemplo de pacote XML
Gestão de endereços IP
<add>
Adicionar um endereço IP a uma regra do firewall.
Requer especificar o identificador de regra como elemento XML:
<RULEID>IP</RULEID>
Adicionar 1.2.3.4 à regra SMTP:
<packet><extension><call><flex-firewall-manager><add><SMTP>1.2.3.4</SMTP></add></flex-firewall-manager></call></extension></packet>
<remove>
Remover um endereço IP de uma regra do firewall.
Requer especificar o identificador de regra como elemento XML:
<RULEID>IP</RULEID>
Remover 1.2.3.4 da regra SMTP:
<packet><extension><call><flex-firewall-manager><remove><SMTP>1.2.3.4</SMTP></remove></flex-firewall-manager></call></extension></packet>
<find>
Buscar um endereço IP nas regras do Firewall do Windows ou nas listas do MailEnable.
Requer especificar o contexto de busca:
-firewall  -mailenable
<PARAM>IP</PARAM>
Buscar 1.2.3.4 no Firewall:
<packet><extension><call><flex-firewall-manager><find><firewall>1.2.3.4</firewall></find></flex-firewall-manager></call></extension></packet>
Buscar 1.2.3.4 no MailEnable:
<packet><extension><call><flex-firewall-manager><find><mailenable>1.2.3.4</mailenable></find></flex-firewall-manager></call></extension></packet>
<whitelist>
Adicionar um endereço IP à lista de exceções (whitelist).
Os IPs na whitelist nunca serão bloqueados pelo sistema de proteção automática.
<whitelist>IP</whitelist>
Adicionar 1.2.3.4 à whitelist:
<packet><extension><call><flex-firewall-manager><whitelist>1.2.3.4</whitelist></flex-firewall-manager></call></extension></packet>
Gestão de regras do firewall
<enable>
Habilitar uma regra do firewall.
Requer especificar o identificador de regra <RULEID>.
<enable>RULEID</enable>
Ativar a regra SMTP:
<packet><extension><call><flex-firewall-manager><enable>SMTP</enable></flex-firewall-manager></call></extension></packet>
<disable>
Desativar uma regra do firewall.
Requer especificar o identificador de regra <RULEID>.
<disable>RULEID</disable>
Desativar a regra SMTP:
<packet><extension><call><flex-firewall-manager><disable>SMTP</disable></flex-firewall-manager></call></extension></packet>
<list>
Mostrar a lista de regras disponíveis ou seus identificadores.
Valores aceitos: id  exist
<list>ID</list>
Obter lista de identificadores de regra:
<packet><extension><call><flex-firewall-manager><list>id</list></flex-firewall-manager></call></extension></packet>
Listar nomes de regras existentes:
<packet><extension><call><flex-firewall-manager><list>exist</list></flex-firewall-manager></call></extension></packet>
Controle do sistema e status
<on>
Ativar o Firewall do Windows ou habilitar a extensão Firewall Manager.
Valores aceitos: firewall  extension
<on>ID</on>
Ativar o Firewall do Windows:
<packet><extension><call><flex-firewall-manager><on>firewall</on></flex-firewall-manager></call></extension></packet>
Habilitar a extensão:
<packet><extension><call><flex-firewall-manager><on>extension</on></flex-firewall-manager></call></extension></packet>
<off>
Desativar o Firewall do Windows ou desabilitar a extensão Firewall Manager.
Valores aceitos: firewall  extension
<off>ID</off>
Desativar o Firewall do Windows:
<packet><extension><call><flex-firewall-manager><off>firewall</off></flex-firewall-manager></call></extension></packet>
Desabilitar a extensão:
<packet><extension><call><flex-firewall-manager><off>extension</off></flex-firewall-manager></call></extension></packet>
<status>
Consultar o status do Firewall, da extensão ou dos módulos de proteção ativos.
Valores aceitos: firewall extension protection mailenable smartermail
<status>ID</status>
Status do Firewall do Windows:
<packet><extension><call><flex-firewall-manager><status>firewall</status></flex-firewall-manager></call></extension></packet>
Status da extensão:
<packet><extension><call><flex-firewall-manager><status>extension</status></flex-firewall-manager></call></extension></packet>
Listar status de todas as proteções:
<packet><extension><call><flex-firewall-manager><status>protection</status></flex-firewall-manager></call></extension></packet>
Status do serviço MailEnable:
<packet><extension><call><flex-firewall-manager><status>mailenable</status></flex-firewall-manager></call></extension></packet>
Status do serviço SmarterMail:
<packet><extension><call><flex-firewall-manager><status>smartermail</status></flex-firewall-manager></call></extension></packet>
Módulos de proteção
<protection>
Alternar o estado ativo/inativo de um módulo de proteção específico.
Requer indicar qual módulo terá seu estado alterado:
SMTP IMAP POP FTP SECURITY DB RDP WEB
<protection>ID</protection>
Alternar o módulo SMTP:
<packet><extension><call><flex-firewall-manager><protection>SMTP</protection></flex-firewall-manager></call></extension></packet>
Alternar o módulo RDP:
<packet><extension><call><flex-firewall-manager><protection>RDP</protection></flex-firewall-manager></call></extension></packet>
Ajuda
<help>
Mostrar a ajuda integrada com todos os pacotes disponíveis e sua descrição.
Mostrar ajuda completa:
<packet><extension><call><flex-firewall-manager><help/></flex-firewall-manager></call></extension></packet>