The EvoShield API is a RESTful API provided by Evolution Host that allows users to interact with EvoShield compatible services, including VPS, VDS and Remote Protection services. The API allows users to manage their services, including listing services, retrieving service information, listing active EvoShield rules, adding and deleting rules as well as creating and removing tunnels. This documentation provides an overview of the API endpoints, parameters, and response formats.
API Endpoints
The EvoShield API has several endpoints that can be used to perform different actions. The following are the available endpoints:
- GET /list_services: Lists all EvoShield services on your Evolution Host account.
- GET /list_evoshield_profiles: Lists all available EvoShield rules/profiles that can be applied to a service.
- GET /service_info: Retrieves information about a specific EvoShield service.
- GET /list_active_evoshield_rules: Lists all active EvoShield rules applied to a specific service.
- GET /list_tunnels: Lists all existing tunnels for a specific EvoShield Remote service.
- POST /add_rule: Adds a new EvoShield rule to a specific service.
- POST /delete_rule: Deletes an existing EvoShield rule from a specific service.
- POST /add_tunnel: Creates a new tunnel for a specific EvoShield Remote service.
- POST /remove_tunnel: Removes an existing tunnel from a specific EvoShield Remote service.
Error Codes
EvoShield API errors contain an error_code and description field. The description field contains more information about the error.
The following are the possible error codes returned by the EvoShield API:
- ERROR_REQUEST_TYPE_UNHANDLED: The request type is not supported.
- ERROR_NOT_FOUND: The requested resource was not found.
- ERROR_INVALID_REQUEST: The request is invalid or missing required parameters.
- ERROR_INTERNAL_ERROR: An internal error occurred.
- ERROR_PERM_DENIED: The user does not have permission to perform the requested action.
- ERROR_UNAVAILABLE: The requested resource is currently unavailable.
- ERROR_INSUFFICIENT_FUNDS: The user's account balance is insufficient to perform the requested action.
Security
The EvoShield API uses TLS/HTTPS to encrypt all communication between HTTP the client and server. The API also requires authentication using the user's account key.
Support
If you have any questions or need assistance with the EvoShield API, please contact Evolution Host support at support@evolution-host.com.