Hosting

Web Hosting

📄️List all hostings

Lists the active main hostings of the account, one for each hosting purchase; their subdomains are not included

Deletes a subdomain: it removes it from the web server, uninstalls its SSL certificates and, when the DNS of the domain is a purchase of the same account, deletes its DNS record. Not available (403) when the plan does not include subdomains; 409 on a main hosting

📄️Create subdomain

Creates a subdomain of a main hosting and returns it. When the DNS of the domain is a purchase of the same account, it also adds the A record of the subdomain. Not available (403) when the plan does not include subdomains; 409 on a subdomain, when the limit is reached or when the subdomain or its DNS record already exists

📄️Get hosting credentials

Lists the active FTP, secondary FTP, MySQL and MSSQL accounts of the hosting, with their passwords. The accounts belong to the purchase: a subdomain returns those of its main hosting

📄️Get hosting DNS records

Lists the default DNS records of the hosting: those of its web server and of its mail server, which point the domain to the hosting. They are not read from the DNS zone of the domain; a subdomain returns those of its main hosting

📄️Get hosting databases

Lists the MySQL and MSSQL databases of the hosting, read from the database servers, with the account that owns them. The databases belong to the purchase: a subdomain returns those of its main hosting

📄️Create hosting database

Create a database of the hosting. The request has no body: as in the control panel, the name is `<username of the database account>_<n>`, with the first free n. If the database server already uses that name for another account, it adds a suffix: the response has the actual name

📄️Get hosting database

Returns a database of the hosting, read from the database servers: `database_id` is the name of the database. 404 when the hosting has no database with that name

📄️List hosting email aliases

Get list of email aliases for a hosting (excluding catch-all)

📄️Create hosting email alias

Create a new email alias for the hosting

📄️Get hosting email alias

Get details of a single email alias

📄️Delete hosting email alias

Delete an email alias

📄️Get catch-all alias

Get catch-all alias status and destinations

📄️Create or replace catch-all alias

Sets the destinations of the catch-all alias: the response is 201 when the alias is created, 200 when it replaces the current one

📄️Delete catch-all alias

Delete the catch-all alias

📄️List hosting allow list

Get list of allow list entries for hosting

📄️Create allow list entry

Create a new allow list entry for hosting

📄️Get hosting allow list entry

Get allow list entry details for hosting

📄️Delete allow list entry

Delete an allow list entry for hosting

📄️List hosting block list

Get list of block list entries for hosting

📄️Create block list entry

Create a new block list entry for hosting

📄️Get hosting block list entry

Get block list entry details for hosting

📄️Delete block list entry

Delete a block list entry for hosting

📄️List hosting cronjobs

Get list of cronjobs for a hosting

📄️Create hosting cronjob

Create a new cronjob for hosting

📄️Get hosting cronjob

Get a cronjob details for hosting

📄️Delete hosting cronjob

Delete a cronjob for hosting

📄️Get ModSecurity status

Get ModSecurity configuration status

📄️Update ModSecurity status

Enable or disable ModSecurity

📄️List ModSecurity scans

Get ModSecurity scan history

📄️Get ModSecurity scan

Get ModSecurity scan details

📄️List ModSecurity rules

Lists the ModSecurity rules of the hosting, found by the scans or added by hand. A rule with `included` true is disabled on the hosting: ModSecurity does not apply it

📄️Enable ModSecurity rules

Disables on the hosting the ModSecurity rules with the given ids (`rule_id`), so that ModSecurity no longer applies them, and returns them with `included` true

📄️Create ModSecurity rule

Disables the ModSecurity rule `rule_number` on the hosting, so that ModSecurity no longer applies it, and returns the rule with `included` true. Responds 200 instead of 201 when the hosting already had the rule, found by a scan or added before

📄️Delete all ModSecurity rules

Enables again all the ModSecurity rules disabled on the hosting: ModSecurity applies them again and their `included` becomes false. The rules stay in the list

📄️Get ModSecurity rule

Get a ModSecurity rule details

📄️Delete ModSecurity rule

Enables again the ModSecurity rule `rule_id` on the hosting: ModSecurity applies it again and its `included` becomes false. The rule stays in the list

📄️Update file protection status

Enable or disable file protection. Returns the updated hosting, with `file_protection_enabled`

📄️Update HTTP version

Change HTTP version for hosting. Returns the updated hosting, with `http_version`. Not available (403) on a dedicated web server, on a non-Linux hosting or without multi-PHP; 409 while the purchase is suspended or the hosting is under maintenance

📄️List PHP versions

Get available PHP versions for hosting

📄️Update PHP settings

Update a PHP setting for hosting. Returns the updated hosting: `php_settings` lists the directives changed from the default value of the web server. Not available (403) on a dedicated web server, on a non-Linux hosting or without multi-PHP; 409 while the purchase is suspended or the hosting is under maintenance

📄️Update PHP version

Change PHP version for hosting. Returns the updated hosting, with `php_version`. Not available (403) on a dedicated web server, on a non-Linux hosting or without multi-PHP; 409 while the purchase is suspended or the hosting is under maintenance

📄️Get antivirus status

Get latest antivirus scan status for hosting

📄️List antivirus scans

Get a list of antivirus scans for hosting

📄️Start antivirus scan

Start a manual antivirus scan for hosting

📄️Get antivirus scan

Get antivirus scan details

📄️List antivirus removal scans

Get a list of antivirus removal scans for hosting

📄️Start antivirus removal scan

Start an antivirus removal scan for hosting

📄️Get antivirus removal scan

Get antivirus removal scan details

📄️List hosting SSL certificates

Get list of SSL certificates installed on hosting

📄️Install SSL certificate on hosting

Installs a purchased SSL certificate on the hosting, or issues and installs a Let's Encrypt certificate, with the rules of the control panel. With DNS that are not on our nameservers, Let's Encrypt requires the CNAME record that delegates its DNS validation: `GET /api/v3/hostings/{hosting_id}/ssl-certificates/can-install` tells whether the installation can start, and which record to create. 409 when a certificate is already installed on the destination, the CNAME record is missing, the limit of Let's Encrypt installations is reached, the hosting is not active yet or an operation is running; 403 when the mail server of the hosting does not accept certificates

📄️Get hosting SSL certificate

Get details of a hosting SSL certificate installation

📄️Remove hosting SSL certificate

Remove an SSL certificate installation from hosting

📄️Can install SSL certificate on hosting

Checks, with the rules of the installation (`POST /api/v3/hostings/{hosting_id}/ssl-certificates`) and its fields in the query, whether the SSL certificate can be installed on the hosting now, and why not: a certificate already installed, the CNAME record that delegates the validation of Let's Encrypt missing from DNS that are not on our nameservers (`dns_delegation` has the record to create), the limit of Let's Encrypt installations, the hosting not active yet, an operation running. With DNS on our nameservers the installation creates the CNAME record by itself. Invalid fields respond 400, as in the installation