Nueva Extensión para Plesk. Protección Antivirus para mejorar la seguridad de tu servidor. ¿Por qué elegir Flex Antivirus?

API — Programación Web

Utilidad Plesk - RPC — Paquetes XML

El protocolo API XML permite la interacción remota entre Plesk y aplicaciones de terceros mediante paquetes HTTP estructurados. Envía tu mensaje al endpoint de Plesk, recibe la respuesta de operación y gestiona reglas del firewall de forma programática sin acceder a la interfaz web.

Windows Server API XML Plesk RPC HTTP/HTTPS

¿Qué es la API XML RPC de Firewall Manager?

El protocolo API XML ha sido diseñado para soportar la interacción entre Plesk y software de terceros de forma remota. Para realizar una operación, debe enviar un mensaje HTTP con una estructura específica al endpoint de Plesk: https://<your-host-or-IP>:8443/enterprise/control/agent.php. Plesk recibe el mensaje, lo transforma en instrucciones de operación, las ejecuta y devuelve los estados y detalles del resultado. Si desea más información acerca de la estructura de los paquetes y el transporte de mensajes, consulte Modelo Cliente-Servidor y Paquetes API XML.

Endpoint de la API XML

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

Referencia completa de paquetes CLI RPC


Comando Descripción de Parámetros Ejemplo de paquete XML
Gestión de direcciones IP
<add>
Añadir una dirección IP a una regla del firewall.
Requiere especificar el identificador de regla como elemento XML:
<RULEID>IP</RULEID>
Añadir 1.2.3.4 a la regla SMTP:
<packet><extension><call><flex-firewall-manager><add><SMTP>1.2.3.4</SMTP></add></flex-firewall-manager></call></extension></packet>
<remove>
Eliminar una dirección IP de una regla del firewall.
Requiere especificar el identificador de regla como elemento XML:
<RULEID>IP</RULEID>
Eliminar 1.2.3.4 de la regla SMTP:
<packet><extension><call><flex-firewall-manager><remove><SMTP>1.2.3.4</SMTP></remove></flex-firewall-manager></call></extension></packet>
<find>
Buscar una dirección IP en las reglas del Firewall de Windows o en las listas de MailEnable.
Requiere especificar el contexto de búsqueda:
-firewall  -mailenable
<PARAM>IP</PARAM>
Buscar 1.2.3.4 en el 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 en MailEnable:
<packet><extension><call><flex-firewall-manager><find><mailenable>1.2.3.4</mailenable></find></flex-firewall-manager></call></extension></packet>
<whitelist>
Añadir una dirección IP a la lista de excepciones (whitelist).
Las IPs en la whitelist nunca serán bloqueadas por el sistema de protección automática.
<whitelist>IP</whitelist>
Añadir 1.2.3.4 a la whitelist:
<packet><extension><call><flex-firewall-manager><whitelist>1.2.3.4</whitelist></flex-firewall-manager></call></extension></packet>
Gestión de reglas del firewall
<enable>
Habilitar una regla del firewall.
Requiere especificar el identificador de regla <RULEID>.
<enable>RULEID</enable>
Activar la regla SMTP:
<packet><extension><call><flex-firewall-manager><enable>SMTP</enable></flex-firewall-manager></call></extension></packet>
<disable>
Desactivar una regla del firewall.
Requiere especificar el identificador de regla <RULEID>.
<disable>RULEID</disable>
Desactivar la regla SMTP:
<packet><extension><call><flex-firewall-manager><disable>SMTP</disable></flex-firewall-manager></call></extension></packet>
<list>
Mostrar la lista de reglas disponibles o sus identificadores.
Valores admitidos: id  exist
<list>ID</list>
Obtener lista de identificadores de regla:
<packet><extension><call><flex-firewall-manager><list>id</list></flex-firewall-manager></call></extension></packet>
Listar nombres de reglas existentes:
<packet><extension><call><flex-firewall-manager><list>exist</list></flex-firewall-manager></call></extension></packet>
Control del sistema y estado
<on>
Activar el Firewall de Windows o habilitar la extensión Firewall Manager.
Valores admitidos: firewall  extension
<on>ID</on>
Activar el Firewall de Windows:
<packet><extension><call><flex-firewall-manager><on>firewall</on></flex-firewall-manager></call></extension></packet>
Habilitar la extensión:
<packet><extension><call><flex-firewall-manager><on>extension</on></flex-firewall-manager></call></extension></packet>
<off>
Desactivar el Firewall de Windows o deshabilitar la extensión Firewall Manager.
Valores admitidos: firewall  extension
<off>ID</off>
Desactivar el Firewall de Windows:
<packet><extension><call><flex-firewall-manager><off>firewall</off></flex-firewall-manager></call></extension></packet>
Deshabilitar la extensión:
<packet><extension><call><flex-firewall-manager><off>extension</off></flex-firewall-manager></call></extension></packet>
<status>
Consultar el estado del Firewall, la extensión o los módulos de protección activos.
Valores admitidos: firewall extension protection mailenable smartermail
<status>ID</status>
Estado del Firewall de Windows:
<packet><extension><call><flex-firewall-manager><status>firewall</status></flex-firewall-manager></call></extension></packet>
Estado de la extensión:
<packet><extension><call><flex-firewall-manager><status>extension</status></flex-firewall-manager></call></extension></packet>
Listar estado de todas las protecciones:
<packet><extension><call><flex-firewall-manager><status>protection</status></flex-firewall-manager></call></extension></packet>
Estado del servicio MailEnable:
<packet><extension><call><flex-firewall-manager><status>mailenable</status></flex-firewall-manager></call></extension></packet>
Estado del servicio SmarterMail:
<packet><extension><call><flex-firewall-manager><status>smartermail</status></flex-firewall-manager></call></extension></packet>
Módulos de protección
<protection>
Alternar el estado activo/inactivo de un módulo de protección específico.
Requiere indicar qué módulo se desea cambiar de estado:
SMTP IMAP POP FTP SECURITY DB RDP WEB
<protection>ID</protection>
Alternar el módulo SMTP:
<packet><extension><call><flex-firewall-manager><protection>SMTP</protection></flex-firewall-manager></call></extension></packet>
Alternar el módulo RDP:
<packet><extension><call><flex-firewall-manager><protection>RDP</protection></flex-firewall-manager></call></extension></packet>
Ayuda
<help>
Mostrar la ayuda integrada con todos los paquetes disponibles y su descripción.
Mostrar ayuda completa:
<packet><extension><call><flex-firewall-manager><help/></flex-firewall-manager></call></extension></packet>