/** * Type definitions for the API endpoints * Auto-generated from OpenAPI specification */ export interface APITools { /** * Deploy, publish or upload a website to Hostinger web hosting (Shared, Cloud): static HTML, PHP, a nodejs (Node.js) app, a whole WordPress site, or a WordPress plugin or theme, from a local directory, an archive or a GitHub or GitLab repository. It detects what the project is and does the upload, build and Git setup itself: do not call upload or build operations, and do not archive the directory yourself. WARNING: it overwrites the website's contents and cannot be undone; confirm the domain with the user before deploying to a site that already has content. A Node.js build runs on the server: this returns a buildUuid at once, then call hosting_get-deployment until the build state is completed or failed. A plugin or theme goes into the site's WordPress installation, also when WordPress is in a folder of the document root (headless). Static, PHP, plugin and theme deploys are done when this returns; a WordPress site import only starts, and its files are extracted a few minutes later. From Git, pass type (static or nodejs) unless the site already runs a Node.js app or you pass Node.js settings; a static or PHP site deploys the branch now and again on every push; a Node.js site builds the branch now and on every later push, with the settings stored for the site (when none are stored, pass appType and nodeVersion from the project's engines, plus outputDirectory and buildScript if the app has a build step). Git needs GitHub or GitLab connected once in hPanel. */ "hosting_deploy": { params: { /** * Domain name of the website to deploy to (e.g., example.com) */ domain: string; /** * Local directory (preferred; it is archived for you, skipping node_modules, .git and .env files, but not reading .gitignore, so keep build output out) or archive (zip, tar, tar.gz, tgz, 7z, gz, gzip). Not together with git. */ path?: string; /** * Deploy a repository branch instead of local files. Not together with path. */ git?: object; /** * What is deployed. Detected for a directory (a Plugin Name: or Theme Name: header, wp-config.php or wp-content, a package.json with a build or start script); required for an archive, when detection reports ambiguity, and for a Git deploy unless the site already runs a Node.js app or Node.js settings are passed. static also covers PHP. */ type?: string; /** * WordPress plugin or theme slug: lower-case letters, digits, - and _ (default: the directory name) */ slug?: string; /** * Activate the theme after deployment (WordPress themes only, default: false) */ activate?: boolean; /** * Path to a .sql dump; required for a WordPress site import */ databaseDump?: string; /** * Node.js major version (default: detected from an archive, or stored for the site, else 22; set it from the project's engines for a Git deploy) */ nodeVersion?: number; /** * Node.js framework, e.g. next, nuxt, vite, express, react, vue, astro; overrides detection or stored settings */ appType?: string; /** * Directory with the package.json, relative to the site root (default .) */ rootDirectory?: string; /** * Build output directory relative to the root directory, e.g. dist */ outputDirectory?: string; /** * The package.json script that builds the app, e.g. build */ buildScript?: string; /** * Entry file of a server app. Relative to the root directory for express, fastify, hono, react-router and other; for a compiled (TypeScript) app give the built file, e.g. dist/server.js, because detection guesses a root-level file. Relative to the output directory for nest, nuxt, nitro, astro and svelte-kit (main.js, not dist/main.js). Ignored for next. */ entryFile?: string; /** * Package manager used to install dependencies */ packageManager?: string; }; response: any; // Response structure will depend on the API }; /** * Check deployment status, build status, build logs and why a build failed (failure analysis) for a website's nodejs (Node.js) deployment: the state of its latest build (or of buildUuid), the end of the build log, the failure analysis when the build failed, and the build settings and Git auto-deployment settings stored for the site. Use it after hosting_deploy starts a Node.js build, and to find out why a deployment failed. Poll until the build state is completed or failed, with growing pauses. The log comes back in full; pass fromLine (the lines count from the previous call) to read only new output. A website without Node.js builds returns build: null with an explanation, because static, PHP, plugin and theme deploys are complete when hosting_deploy returns, and a WordPress site import is ready a few minutes after it starts. */ "hosting_get-deployment": { params: { /** * Domain name of the website (e.g., example.com) */ domain: string; /** * Build to inspect, as returned by hosting_deploy (default: the latest build) */ buildUuid?: string; /** * Read the build log from this line on (default 0, the whole log). Pass the lines count returned by the previous call to get only new output. */ fromLine?: number; }; response: any; // Response structure will depend on the API }; /** * Deploy a node-static Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites of type node-static (a Node.js-built static site that requires a build step or a plain simple static site). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the build-assets process which builds the site and deploys the result to public_html. This operation is synchronous: the build and deployment complete before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For plain PHP applications that should be extracted as-is, use agency-hosting_deploy-php-application instead. The website UID is automatically resolved from the domain. */ "agency-hosting_deploy-node-static-website": { params: { /** * Domain name of the Agency Plan website (e.g., example.com) */ domain: string; /** * Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz. The archive must contain the application source files. If user provides a directory path, create an archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip) */ archivePath: string; /** * Whether to remove the local archive file after successful deployment (default: true) */ removeArchive?: boolean; }; response: any; // Response structure will depend on the API }; /** * Deploy a PHP (or other non-build) Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites where the archive contents should be extracted and served as-is with no build step (e.g., PHP applications). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the import-archive process which overwrites the website contents with the archive contents. This operation is synchronous: the archive is extracted and deployed before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For node-static websites that require a build step, use agency-hosting_deploy-node-static-website instead. The website UID is automatically resolved from the domain. */ "agency-hosting_deploy-php-application": { params: { /** * Domain name of the Agency Plan website (e.g., example.com) */ domain: string; /** * Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz. If user provides a directory path, create an archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip) */ archivePath: string; /** * Whether to remove the local archive file after successful deployment (default: true) */ removeArchive?: boolean; }; response: any; // Response structure will depend on the API }; /** * Import a WordPress website from an archive file to a hosting server. This tool uploads a website archive (zip, tar, tar.gz, etc.) and a database dump (.sql file) to deploy a complete WordPress website. The archive will be extracted on the server automatically. Note: This process may take a while for larger sites. After upload completion, files are being extracted and the site will be available in a few minutes. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end. The username will be automatically resolved from the domain. */ "hosting_import-wordpress-website": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip) */ archivePath: string; /** * Absolute or relative path to a database dump file (.sql) */ databaseDump: string; }; response: any; // Response structure will depend on the API }; /** * Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end. */ "hosting_deploy-wordpress-plugin": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * WordPress plugin slug (e.g., omnisend) */ slug: string; /** * Absolute or relative path to the plugin directory containing all plugin files */ pluginPath: string; }; response: any; // Response structure will depend on the API }; /** * Deploy a WordPress theme from a directory to a hosting server. This tool uploads all theme files and triggers theme deployment. The uploaded theme can optionally be activated after deployment. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end. */ "hosting_deploy-wordpress-theme": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * WordPress theme slug (e.g., twentytwentyfive) */ slug: string; /** * Absolute or relative path to the theme directory containing all theme files */ themePath: string; /** * Whether to activate the theme after deployment (default: false) */ activate?: boolean; }; response: any; // Response structure will depend on the API }; /** * Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. After deployment, use the hosting_list-js-deployments tool to check deployment status and track build progress. */ "hosting_deploy-js-application": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * Absolute or relative path to the application archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory. */ archivePath: string; /** * Whether to remove the archive file after successful deployment (default: false) */ removeArchive?: boolean; }; response: any; // Response structure will depend on the API }; /** * Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use hosting_deploy-js-application instead. The tool uploads the archive to the website's file browser over TUS and triggers deployment; the archive is extracted and deployed directly without any build steps. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. The username will be automatically resolved from the domain. */ "hosting_deploy-static-website": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * Absolute or relative path to the static website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mystaticwebsite_20250115_143022.zip) */ archivePath: string; /** * Whether to remove the archive file after successful deployment (default: false) */ removeArchive?: boolean; }; response: any; // Response structure will depend on the API }; /** * List javascript application deployments for checking their status. Use this tool when customer asks for the status of the deployment. This tool retrieves a paginated list of Node.js application deployments for a domain with optional filtering by deployment states. */ "hosting_list-js-deployments": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * Page number for pagination (optional) */ page?: number; /** * Number of items per page (optional) */ perPage?: number; /** * Filter by deployment states (optional). Valid values: pending, completed, running, failed */ states?: array; }; response: any; // Response structure will depend on the API }; /** * Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure. */ "hosting_show-js-deployment-logs": { params: { /** * Domain name associated with the hosting account (e.g., example.com) */ domain: string; /** * Line from which to retrieve logs (optional, default 0) */ fromLine?: number; /** * UUID of the JavaScript deployment build */ buildUuid: string; }; response: any; // Response structure will depend on the API }; /** * Lists the datacenters available for provisioning a new website on the given Agency Plan hosting order. Each datacenter includes a `pinger_url` you can ping from the client to measure round-trip latency; comparing the results across datacenters lets you pick the nearest one (lowest ping) before choosing its `code` as the `datacenter_code` when creating a website setup. */ "agency-hosting_datacenters_list": { params: { /** * Agency Plan order ID */ order_id: number; }; response: any; // Response structure will depend on the API }; /** * Changes the primary domain for an Agency Plan website. Provide the current domain in the path and the new domain in the request body. Set domain to null to revert to the temporary domain. */ "agency-hosting_domains_change-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Current domain name to change from */ from_domain: string; /** * New domain to assign to the website. Set to null to revert to the temporary domain. */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Links a domain to the specified Agency Plan website so it can serve traffic for that domain. */ "agency-hosting_domains_link-to-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Fully qualified domain name to link to the website */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of domains associated with Agency Plan websites accessible to the authenticated client. Use the website_uuids filter to narrow results to specific websites. */ "agency-hosting_domains_list": { params: { /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Filter by website UIDs */ website_uuids?: array; }; response: any; // Response structure will depend on the API }; /** * Unlinks a domain from the specified Agency Plan website. The website stops serving traffic on this domain immediately. Website files and database are preserved, and any other linked domains remain accessible. If this is the only domain on the website, unlinking leaves the website without an accessible domain. */ "agency-hosting_domains_unlink-from-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website's file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website's file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website's file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux curl -i -X POST "{url}/${FILE}?override=true" \ -H "X-Auth: {auth_key}" \ -H "X-Auth-Rest: {rest_auth_key}" \ -H "Tus-Resumable: 1.0.0" \ -H "Upload-Length: ${SIZE}" \ -H "Upload-Offset: 0" # -> 201 Created curl -i -X PATCH "{url}/${FILE}?override=true" \ -H "X-Auth: {auth_key}" \ -H "X-Auth-Rest: {rest_auth_key}" \ -H "Tus-Resumable: 1.0.0" \ -H "Content-Type: application/offset+octet-stream" \ -H "Upload-Offset: 0" \ --data-binary "@${FILE}" # -> 204 No Content, Upload-Offset response header equals SIZE when done ``` */ "agency-hosting_files_generate-upload-url": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website's root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz. */ "agency-hosting_files_import-website-from-archive": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Archive filename (e.g., archive.zip). The file must already be uploaded to the website's .h5g/ directory. */ archive_name: string; }; response: any; // Response structure will depend on the API }; /** * Returns aggregated disk and inode usage for the Agency Plan order over the selected time frame, plus the plan quotas. Figures cover the whole order account. Values may be up to one hour stale. CPU, memory, and process usage are on the resource-usage-metrics endpoint. */ "agency-hosting_metrics_list-plan-order-disk-usage": { params: { /** * Agency Plan order ID */ order_id: number; /** * Length of the window in days, ending now. Bucket size grows with the window. */ time_frame_days?: number; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of Agency Plan orders accessible to the authenticated client. */ "agency-hosting_orders_list": { params: { /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Returns aggregated CPU, memory, and process usage for the Agency Plan order over the selected time frame, plus the plan quotas and a per-website breakdown. Each website is identified by uid. Suspended and deleted websites are excluded from both the order totals and the per-website breakdown. Values may be up to one hour stale. Disk and inode usage are on the disk-usage-metrics endpoint. */ "agency-hosting_metrics_list-order-resource-usage": { params: { /** * Agency Plan order ID */ order_id: number; /** * Length of the window in hours, ending now. Bucket size grows with the window. */ time_frame_hours?: number; }; response: any; // Response structure will depend on the API }; /** * Lists every PHP extension available to an Agency Plan website and whether it is currently enabled. */ "agency-hosting_php_list-extensions-for-website": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the "built-in" state, are always active and are unaffected. */ "agency-hosting_php_replace-website-extensions": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Extension names, exactly as returned by the extensions endpoint. */ extensions: array; }; response: any; // Response structure will depend on the API }; /** * Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts. */ "agency-hosting_php_list-options-for-website": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default. */ "agency-hosting_php_replace-website-options": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Option names and values. Each name must be one of the options returned by the options endpoint, and each value must satisfy that option's allowed_values when it declares them. */ options: array; }; response: any; // Response structure will depend on the API }; /** * Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead. */ "agency-hosting_php_list-versions-for-order": { params: { /** * Agency Plan order ID */ order_id: number; }; response: any; // Response structure will depend on the API }; /** * Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint. */ "agency-hosting_php_list-versions-for-website": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break. */ "agency-hosting_php_update-website-version": { params: { /** * Agency Plan website UID */ website_uid: string; /** * PHP version to switch the website to, as major.minor. Must be one of the versions returned by the available versions endpoint. */ version: string; }; response: any; // Response structure will depend on the API }; /** * Provisions a new website on one of your Agency Plan hosting orders. Choose the datacenter, stack (`flavor`), and PHP version for the site. Optionally attach your own `domain` — omit it, set it to `null`, or leave it unavailable and a free `*.hostingersite.com` subdomain is generated instead — and/or install WordPress by supplying the `wordpress` details (admin account, site title, and language). Common setups: - **Plain PHP site**: `flavor` set to `php-fpm`, with `settings.php.version`; omit `wordpress` and `type`. - **WordPress site**: `flavor` set to the desired WordPress version (e.g. `wp-7.0`), plus the `wordpress` block (admin account, title, language). - **Static/Node.js frontend app**: `flavor` set to `php-fpm` and `type` set to `node-static`. Provisioning runs in the background, so the response returns immediately with a setup UUID that identifies the job. The new website becomes reachable once provisioning finishes. */ "agency-hosting_website-setups_create": { params: { /** * Agency Plan order ID */ order_id: number; /** * Datacenter code where the website should be provisioned. Available codes depend on live capacity and are not a fixed set. */ datacenter_code: string; /** * Setup flavor: a specific WordPress version in the format `wp-.` or `wp-..` (e.g. `wp-6.8.2`), or `php-fpm` for a plain PHP stack. Generic versions like `wp-latest` are not allowed. */ flavor: string; /** * Website settings */ settings: object; /** * Primary domain to attach to the website. Omit or set to null to get a free auto-generated *.hostingersite.com subdomain instead. */ domain?: string; /** * Website type */ type?: string; /** * WordPress installation options */ wordpress?: object; }; response: any; // Response structure will depend on the API }; /** * Returns the current status of an Agency Plan website setup started via the setups endpoint. Poll this endpoint using the `setup_uuid` returned from the provisioning request until `status` becomes `completed`, at which point `website_uid` identifies the new website. */ "agency-hosting_website-setups_status": { params: { /** * Agency Plan order ID */ order_id: number; /** * Website setup UUID */ setup_uuid: string; }; response: any; // Response structure will depend on the API }; /** * Replaces the Let's Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist. */ "agency-hosting_ssl_reinstall-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Starts a Let's Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist. */ "agency-hosting_ssl_install-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist. */ "agency-hosting_ssl_website-status": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Removes the platform-issued Let's Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist. */ "agency-hosting_ssl_uninstall-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Builds and deploys a Node.js application for an Agency Plan website from an already-uploaded archive. Upload the archive to file browser first, then provide its relative path from document root in this request. Website contents are overwritten by the build result, which is deployed to public_html. */ "agency-hosting_websites_build-nodejs-assets": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Directory, relative to the website document root, where the uploaded site archive currently lives. Most commonly this is simply `public_html`. */ archive_path: string; }; response: any; // Response structure will depend on the API }; /** * Clears cache for all domains associated with an Agency Plan website, including its preview domain. This operation clears all cache types for the website. */ "agency-hosting_cache_clear-website": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of cron jobs configured for an Agency Plan website. Each entry includes the schedule expression and the command executed on that schedule. */ "agency-hosting_cron-jobs_list-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Creates a cron job for an Agency Plan website from a schedule expression and a command. Returns the created cron job, including its uuid, which is required to delete the cron job. */ "agency-hosting_cron-jobs_create-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Cron schedule expression (standard 5-field crontab syntax). */ time: string; /** * Command to run on the schedule. Must not contain pipe (|) or redirection (<, >) characters. */ command: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes the cron job identified by its uuid from an Agency Plan website. The operation is idempotent: deleting a cron job that does not exist succeeds without error. */ "agency-hosting_cron-jobs_delete-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Unique identifier of the cron job as returned by the list cron jobs endpoint. */ uuid: string; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of MySQL databases created for an Agency Plan website. Each entry includes the database's non-system users. */ "agency-hosting_databases_list-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Creates a MySQL database with a dedicated user for an Agency Plan website. The database name, username, and password must all be provided by the caller. */ "agency-hosting_databases_create-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Database name to create (alphanumeric characters). */ database_name: string; /** * Database username to create alongside the database (alphanumeric characters). */ database_user: string; /** * Password for the database user (requires mixed case, letters, and numbers). */ password: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes a MySQL database and all its data from an Agency Plan website, including its users. The operation is idempotent: deleting a database that does not exist succeeds without error. */ "agency-hosting_databases_delete-website": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Full database name as returned by the list databases endpoint. */ database_name: string; }; response: any; // Response structure will depend on the API }; /** * Creates a user for an existing database on an Agency Plan website. Each database supports a single non-system user; creating a user for a database that already has one fails. */ "agency-hosting_databases_create-website-user": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Full database name as returned by the list databases endpoint. */ database_name: string; /** * Database username to create (alphanumeric and underscores). */ database_user: string; /** * Password for the database user (requires mixed case, letters, and numbers). */ password: string; /** * Host the user connects from (IPv4, IPv6, % wildcard, or localhost). Defaults to localhost. */ host?: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes a database user from an Agency Plan website database, revoking all access it had. The operation is idempotent: deleting a user that does not exist succeeds without error. */ "agency-hosting_databases_delete-website-user": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Full database name as returned by the list databases endpoint. */ database_name: string; /** * Database username as returned by the list databases endpoint. */ database_user_name: string; }; response: any; // Response structure will depend on the API }; /** * Retrieves detailed information about a specific Agency Plan website, including configuration, status, metadata, hosting plan details, and resource quotas. */ "agency-hosting_websites_get": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes an Agency Plan website. Deletion is processed asynchronously: the website is immediately transitioned to a deleting state and the underlying server resources are removed in the background. */ "agency-hosting_websites_delete": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of Agency Plan websites (H5G, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. The response shape differs per platform — see the `platform` field on each item. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more targeted results. */ "agency-hosting_websites_list-plan": { params: { /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Filter by order IDs. Accepts a comma-separated list. */ order_ids?: array; /** * Filter by website state. Accepts a comma-separated list. */ states?: array; /** * Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list. */ website_types?: array; /** * Filter by domain name (case-insensitive substring match) */ domain?: string; }; response: any; // Response structure will depend on the API }; /** * Lists active and recently completed asynchronous processes for an Agency Plan website. Each process has a unique ID (for tracking), a type, and a status (running, completed, failed). Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress. */ "agency-hosting_websites_list-processes": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Changes the installed WordPress core version on an Agency Plan website to one of the versions available for installation. */ "agency-hosting_wordpress_change-version": { params: { /** * Agency Plan website UID */ website_uid: string; /** * Target WordPress core version to install. Must be one of the available versions. */ version: string; }; response: any; // Response structure will depend on the API }; /** * Returns the current WordPress settings for an Agency Plan website: installed core version, LiteSpeed Cache plugin status, object cache status, and maintenance mode status. */ "agency-hosting_wordpress_settings": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * Lists the WordPress core versions available for installation on an Agency Plan website. */ "agency-hosting_wordpress_list-versions": { params: { /** * Agency Plan website UID */ website_uid: string; }; response: any; // Response structure will depend on the API }; /** * List every check an agent readiness scan runs, with its name, category and weight.\n Use it to show the human-readable name of each `check_id` in a scan's results. */ "agent-readiness_checks_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Start a scan of how ready a public website is for AI agents to discover, read and act on.\n Scanning is asynchronous: this operation only starts the scan, and the returned scan is usually `pending` with no results yet. To get the results, poll the `Get agent readiness scan` operation with the same domain every few seconds until its status is `completed` or `failed`. The scan itself is limited to 60 seconds, plus any time it waits in the queue. A `failed` scan is not retried; run this operation again.\n Starting a scan for a domain that already has a pending scan from the last 5 minutes returns that scan instead of starting a new one. */ "agent-readiness_scans_run": { params: { /** * Domain name or full URL of the website to scan. Only the host is used. */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Get the latest agent readiness scan of a website.\n Scans started with the `Run agent readiness scan` operation are asynchronous. While the status is `pending`, the result fields are null; wait a few seconds and call this operation again until the status is `completed` or `failed`. A `failed` scan is not retried; run the scan again.\n A completed scan has a 0-100 score, a letter grade, a score per category, and the result of every check with the evidence found and how to fix it. Check names are listed by the `List checks` operation.\n Returns 404 when the domain has never been scanned; use the `Run agent readiness scan` operation first. */ "agent-readiness_scans_get": { params: { /** * Domain name the scan was run for */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve catalog items available for order. Prices in catalog items is displayed as cents (without floating point), e.g: float `17.99` is displayed as integer `1799`. Use this endpoint to view available services and pricing before placing orders. */ "billing_catalog_list": { params: { /** * Filter catalog items by category */ category?: string; /** * Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain */ name?: string; }; response: any; // Response structure will depend on the API }; /** * Create a purchase order for any Hostinger product. This unified endpoint places an order for one or more catalog items and works across all Hostinger products, leveraging the existing billing infrastructure. Use the [catalog endpoint](#tag/billing-catalog) to look up the `item_id` values available for purchase. If no payment method is provided, your default payment method will be used automatically. If the response is `202 Accepted`, the payment is still being processed and the order will complete asynchronously once the payment is confirmed. This endpoint only places the order. Product-specific provisioning (e.g. VPS setup or domain registration) is not performed here — once the order completes, use the relevant product endpoints or [hPanel](https://hpanel.hostinger.com/) to finalize setup. Use this endpoint to purchase any product available in the catalog. */ "billing_orders_create-purchase": { params: { /** * Payment method ID, default will be used if not provided */ payment_method_id?: number; /** * Catalog price items to purchase */ items: array; /** * Discount coupon codes */ coupons?: array; }; response: any; // Response structure will depend on the API }; /** * Set the default payment method for your account. Use this endpoint to configure the primary payment method for future orders. */ "billing_payment-methods_set-default": { params: { /** * Payment method ID */ paymentMethodId: number; }; response: any; // Response structure will depend on the API }; /** * Delete a payment method from your account. Use this endpoint to remove unused payment methods from user accounts. */ "billing_payment-methods_delete": { params: { /** * Payment method ID */ paymentMethodId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve available payment methods that can be used for placing new orders. If you want to add new payment method, please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods). Use this endpoint to view available payment options before creating orders. */ "billing_payment-methods_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieve a list of all subscriptions associated with your account. Use this endpoint to monitor active services and billing status. */ "billing_subscriptions_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Disable auto-renewal for a subscription. Use this endpoint when disable auto-renewal for a subscription. */ "billing_subscriptions_disable-auto-renewal": { params: { /** * Subscription ID */ subscriptionId: string; }; response: any; // Response structure will depend on the API }; /** * Enable auto-renewal for a subscription. Use this endpoint when enable auto-renewal for a subscription. */ "billing_subscriptions_enable-auto-renewal": { params: { /** * Subscription ID */ subscriptionId: string; }; response: any; // Response structure will depend on the API }; /** * Create a renewal order for an existing Hostinger subscription. This endpoint places a renewal order for a single subscription, leveraging the existing billing infrastructure. Use the [subscriptions endpoint](#tag/billing-subscriptions) to look up the `subscriptionId` values available for renewal. If no payment method is provided, your default payment method will be used automatically. If the response is `202 Accepted`, the payment is still being processed and the renewal will complete asynchronously once the payment is confirmed. Use this endpoint to renew any subscription available in your account. */ "billing_subscriptions_renew": { params: { /** * Subscription ID */ subscriptionId: string; /** * Payment method ID, default will be used if not provided */ payment_method_id?: number; /** * Discount coupon codes */ coupons?: array; }; response: any; // Response structure will depend on the API }; /** * Retrieve particular DNS snapshot with contents of DNS zone records. Use this endpoint to view historical DNS configurations for domains. */ "dns_snapshots_get": { params: { /** * Domain name */ domain: string; /** * Snapshot ID */ snapshotId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve DNS snapshots for a domain. Use this endpoint to view available DNS backup points for restoration. */ "dns_snapshots_list": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Restore DNS zone to the selected snapshot. Use this endpoint to revert domain DNS to a previous configuration. */ "dns_snapshots_restore": { params: { /** * Domain name */ domain: string; /** * Snapshot ID */ snapshotId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve DNS zone records for a specific domain. Use this endpoint to view current DNS configuration for domain management. */ "dns_records_list": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Update DNS records for the selected domain. Using `overwrite = true` will replace existing records with the provided ones. Otherwise existing records will be updated and new records will be added. Use this endpoint to modify domain DNS configuration. */ "dns_records_update": { params: { /** * Domain name */ domain: string; /** * If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created. */ overwrite?: boolean; /** * zone parameter */ zone: array; }; response: any; // Response structure will depend on the API }; /** * Delete DNS records for the selected domain. To filter which records to delete, add the `name` of the record and `type` to the filter. Multiple filters can be provided with single request. If you have multiple records with the same name and type, and you want to delete only part of them, refer to the `Update zone records` endpoint. Use this endpoint to remove specific DNS records from domains. */ "dns_records_delete": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Reset DNS zone to the default records. Use this endpoint to restore domain DNS to original configuration. */ "dns_records_reset": { params: { /** * Domain name */ domain: string; /** * Determines if operation should be run synchronously */ sync?: boolean; /** * Determines if email records should be reset */ reset_email_records?: boolean; /** * Specifies which record types to not reset */ whitelisted_record_types?: array; }; response: any; // Response structure will depend on the API }; /** * Validate DNS records prior to update for the selected domain. If the validation is successful, the response will contain `200 Success` code. If there is validation error, the response will fail with `422 Validation error` code. Use this endpoint to verify DNS record validity before applying changes. */ "dns_records_validate": { params: { /** * Domain name */ domain: string; /** * If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created. */ overwrite?: boolean; /** * zone parameter */ zone: array; }; response: any; // Response structure will depend on the API }; /** * Retrieve a list of pending and completed domain verifications. */ "domains_verifications_direct": { params: { }; response: any; // Response structure will depend on the API }; /** * Suggest available domain names based on a free-text description of your project. Suggestions are generated by an AI model, so they differ between calls. Endpoint has rate limit of 90 requests per minute. Use this endpoint to find a domain name when you only know what the website is about. */ "domains_availability_suggest-names-from-description": { params: { /** * Free-text description of the project the domain is needed for */ description: string; /** * Amount of domain names to suggest */ limit: number; }; response: any; // Response structure will depend on the API }; /** * Suggest available domain names based on a domain name you already have in mind. Suggestions are generated by an AI model, so they differ between calls. Endpoint has rate limit of 90 requests per minute. Use this endpoint when the domain you wanted is taken and you need close alternatives. */ "domains_availability_suggest-names-from": { params: { /** * Domain name to base the suggestions on */ domain: string; /** * Amount of domain names to suggest */ limit: number; }; response: any; // Response structure will depend on the API }; /** * Check availability of domain names across multiple TLDs. Multiple TLDs can be checked at once. If you want alternative domains with response, provide only one TLD and set `with_alternatives` to `true`. TLDs should be provided without leading dot (e.g. `com`, `net`, `org`). Endpoint has rate limit of 90 requests per minute. Use this endpoint to verify domain availability before purchase. */ "domains_availability_check": { params: { /** * Domain name (without TLD) */ domain: string; /** * TLDs list */ tlds: array; /** * Should response include alternatives */ with_alternatives?: boolean; }; response: any; // Response structure will depend on the API }; /** * Retrieve domain forwarding data. Use this endpoint to view current redirect configuration for domains. */ "domains_forwarding_get": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Update domain forwarding configuration. Use this endpoint to modify existing redirect configuration for domains. */ "domains_forwarding_update": { params: { /** * Domain name */ domain: string; /** * Redirect type */ redirect_type: string; /** * URL to forward domain to */ redirect_url: string; }; response: any; // Response structure will depend on the API }; /** * Delete domain forwarding data. Use this endpoint to remove redirect configuration from domains. */ "domains_forwarding_delete": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Create domain forwarding configuration. Use this endpoint to set up domain redirects to other URLs. */ "domains_forwarding_create": { params: { /** * Domain name */ domain: string; /** * Redirect type */ redirect_type: string; /** * URL to forward domain to */ redirect_url: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a pending IRTP verification for a domain. Both the old and new registrant must confirm it before the WHOIS change takes effect. Use this endpoint to check the status of a WHOIS change awaiting registrant confirmation. */ "domains_whois_pending-irtp-verification": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Cancel a pending IRTP verification. Use this endpoint to back out of a WHOIS change that is stuck waiting on registrant confirmation, for example when the confirmation email cannot be received, without waiting out the 5-day expiry. */ "domains_whois_cancel-pending-irtp-verification": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve the incoming move for a specified domain. Returns 404 when no account is moving this domain to you. Use this endpoint to check whether a domain addressed to you is still waiting to be accepted. */ "domains_move_incoming": { params: { /** * Domain name */ domain: string; /** * Re-check the move against the registry before responding. Only has an effect while the move is in the `activating` status. */ force_sync?: boolean; }; response: any; // Response structure will depend on the API }; /** * Accept an incoming move for a specified domain. The provided WHOIS profiles become the contacts of the domain, so they must belong to your account and satisfy the requirements of the TLD. Only the contact types the domain actually uses are applied, but all four profile IDs have to be provided. The move has to still be waiting for your decision, already accepted moves cannot be accepted again. Accepting does not complete the move. A confirmation email is sent to the email address of the new owner contact, and the domain changes hands only after the change is confirmed from it. Until then the move stays in the `activating` status, which can be followed with the [incoming move endpoint](#tag/domains-move). Use this endpoint to take ownership of a domain offered to you. */ "domains_move_accept-incoming": { params: { /** * Domain name */ domain: string; /** * WHOIS profiles of the accepting account. Only the contact types required by the TLD are applied, but all four IDs must be provided. */ domain_contacts: object; }; response: any; // Response structure will depend on the API }; /** * Reject an incoming move for a specified domain. The domain stays in the account which initiated the move. Moves you have already accepted cannot be rejected anymore. Use this endpoint to decline a domain you do not want to take over. */ "domains_move_reject-incoming": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all domains other Hostinger accounts are moving to your account. Moves of every status are returned, including the ones which already completed. Use this endpoint to find domains waiting for you to accept them. */ "domains_move_incoming-list": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieve the outgoing move for a specified domain. Returns 404 when the domain has no move in progress. Use this endpoint to track the status of a move you have initiated for a single domain. */ "domains_move_outgoing": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Initiate a move of a specified domain to another Hostinger account. The receiving account has to already exist and accept the move before the domain changes hands. The domain must be active. The subscription it belongs to is resolved automatically, and the request is rejected with a 404 status code when the domain has no domain subscription of its own. Domains protected by premium protection require an additional verification step, such requests are rejected with a 428 status code. Use this endpoint to hand a domain over to another Hostinger user. */ "domains_move_start-outgoing": { params: { /** * Domain name */ domain: string; /** * Email address of the Hostinger account receiving the domain */ new_customer_email: string; }; response: any; // Response structure will depend on the API }; /** * Cancel an outgoing move for a specified domain. The move can only be cancelled while the receiving account has not accepted it yet. The domain stays in your account. Use this endpoint to withdraw a move you no longer want to complete. */ "domains_move_cancel-outgoing": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all domains you are moving to other Hostinger accounts. Only moves which have not completed yet are returned. Use this endpoint to track moves you have initiated and the accounts they are addressed to. */ "domains_move_outgoing-list": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieve the authorization (EPP) code for a specified domain so it can be transferred away from Hostinger to another registrar. Requesting a new code invalidates any code retrieved previously. Use this endpoint to obtain the code required to transfer a domain to another registrar. */ "domains_portfolio_authorization-code": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Claim a free domain available on your account and register it. Unlike purchasing a domain, this consumes a free domain you already have, so no payment method is required. A successful response means the domain is registered. If registration fails, login to [hPanel](https://hpanel.hostinger.com/) and check domain registration status. If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Some TLDs require `additional_details` to be provided and these will be validated before claiming. Requests which cannot be fulfilled are rejected with an error code in the response body, for example `2037` when no free domain is available. Use this endpoint to register a domain using a free domain from your account. */ "domains_portfolio_claim-free": { params: { /** * Domain name */ domain: string; /** * Domain contact information */ domain_contacts?: object; /** * Additional registration data, possible values depends on TLD */ additional_details?: object; }; response: any; // Response structure will depend on the API }; /** * Enable domain lock for the domain. When domain lock is enabled, the domain cannot be transferred to another registrar without first disabling the lock. Use this endpoint to secure domains against unauthorized transfers. */ "domains_portfolio_enable-lock": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Disable domain lock for the domain. Domain lock needs to be disabled before transferring the domain to another registrar. Use this endpoint to prepare domains for transfer to other registrars. */ "domains_portfolio_disable-lock": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve detailed information for specified domain. Use this endpoint to view comprehensive domain configuration and status. */ "domains_portfolio_get": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all domains associated with your account. Use this endpoint to view user's domain portfolio. */ "domains_portfolio_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Purchase and register a new domain name. If registration fails, login to [hPanel](https://hpanel.hostinger.com/) and check domain registration status. If no payment method is provided, your default payment method will be used automatically. If the response is `202 Accepted`, the payment is still being processed and the domain was **not** registered. Once the order completes, register the domain from [hPanel](https://hpanel.hostinger.com/). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Some TLDs require `additional_details` to be provided and these will be validated before completing purchase. Use this endpoint to register new domains for users. */ "domains_portfolio_purchase": { params: { /** * Domain name */ domain: string; /** * Catalog price item ID */ item_id: string; /** * Payment method ID, default will be used if not provided */ payment_method_id?: number; /** * Domain contact information */ domain_contacts?: object; /** * Additional registration data, possible values depends on TLD */ additional_details?: object; /** * Discount coupon codes */ coupons?: array; }; response: any; // Response structure will depend on the API }; /** * Enable privacy protection for the domain. When privacy protection is enabled, domain owner's personal information is hidden from public WHOIS database. Use this endpoint to protect domain owner's personal information from public view. */ "domains_portfolio_enable-privacy-protection": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Disable privacy protection for the domain. When privacy protection is disabled, domain owner's personal information is visible in public WHOIS database. Use this endpoint to make domain owner's information publicly visible. */ "domains_portfolio_disable-privacy-protection": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve renewal information for a specified domain, including its status and current expiration date. Use this endpoint to build renewal automation and expiry monitoring for a single domain. */ "domains_portfolio_renewal-information": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Register a domain you have already paid for but which has not been set up yet. Use this endpoint when an order completed without registering the domain, for example when `Purchase new domain` returned `202 Accepted` and the domain was added to your account without being registered, or when an earlier setup attempt failed. No new order is placed and no payment is taken: the subscription you already own is used, for the period you already paid for. A domain is left awaiting setup when the details needed to register it were missing or invalid as the order completed. Domains ordered elsewhere can be awaiting setup for the same reason. Complete the missing information, then call this endpoint. If the order itself has not completed yet, the domain is not on your account, wait until it appears in `Get domain list`. If `domain_contacts` is omitted, the default WHOIS profile of that TLD is used for all four roles. The profile must exist and be complete for the TLD, an incomplete profile is the most common reason a domain is left awaiting setup. Create one with `Create WHOIS profile`. Some TLDs require `additional_details`. These are validated before setup, so a missing or invalid value is rejected without any registration being attempted. The domain is set up with the default nameservers and without privacy protection. Use `Update domain nameservers` and `Enable privacy protection` afterwards to change either. A successful response means the setup request was accepted, not that the domain is already registered. Poll `Get domain list` for the outcome, the domain appears in `Get domain details` only once it is registered. Use this endpoint to finish registering a domain that is awaiting setup on your account. */ "domains_portfolio_complete-setup": { params: { /** * Domain name */ domain: string; /** * Domain contact information */ domain_contacts?: object; /** * Additional registration data, possible values depends on TLD */ additional_details?: object; }; response: any; // Response structure will depend on the API }; /** * Set nameservers for a specified domain. Be aware, that improper nameserver configuration can lead to the domain being unresolvable or unavailable. Use this endpoint to configure custom DNS hosting for domains. */ "domains_portfolio_update-nameservers": { params: { /** * Domain name */ domain: string; /** * First name server */ ns1: string; /** * Second name server */ ns2: string; /** * Third name server */ ns3?: string; /** * Fourth name server */ ns4?: string; }; response: any; // Response structure will depend on the API }; /** * Claim a free domain transfer available on your account and start the transfer. Unlike purchasing a transfer, this consumes a free domain transfer you already have, so no payment method is required. Before making request, unlock the domain at the current registrar and get its authorization code. The transfer is validated first, so domains which cannot be transferred are rejected before the free domain transfer is consumed. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Requests which cannot be fulfilled are rejected with an error code in the response body. Use this endpoint to transfer a domain using a free domain transfer from your account. */ "domains_transfer_claim-free": { params: { /** * Domain name */ domain: string; /** * Authorization code from the current registrar */ auth_code: string; /** * Domain contact information */ domain_contacts?: object; /** * Keep the existing nameservers of the domain */ should_keep_ns?: boolean; }; response: any; // Response structure will depend on the API }; /** * Retrieve the transfer for a specified domain. Use this endpoint to track an incoming or outgoing registrar transfer and its status. */ "domains_transfer_get": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all domain transfers in your portfolio. Use this endpoint to monitor incoming and outgoing registrar transfers across your domains. */ "domains_transfer_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Transfer a domain from another registrar to your account. The transfer runs on a domain transfer service you have already purchased. Before making request, unlock the domain at the current registrar and get its authorization code. A successful response means the transfer has been started. Completion depends on the current registrar and can be followed with the [transfer list endpoint](#tag/domains-transfer). If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account. Use this endpoint to bring domains registered elsewhere into your account. */ "domains_transfer_start": { params: { /** * Domain name */ domain: string; /** * Authorization code from the current registrar */ auth_code: string; /** * Domain contact information */ domain_contacts?: object; /** * Keep the existing nameservers of the domain */ should_keep_ns?: boolean; }; response: any; // Response structure will depend on the API }; /** * Change WHOIS contact profile for a domain. Repoints the given contact roles to a new WHOIS profile and submits the change to the registry. The profile currently assigned to those roles is resolved automatically; the request fails if the given roles are not all on the same profile today. Changing transfer sensitive fields on the owner contact starts an IRTP verification. The change is processed asynchronously. Use this endpoint to move a registered domain onto different contact information. */ "domains_whois_change-for": { params: { /** * WHOIS profile ID to assign to the domain */ new_whois_id: number; /** * Domain name */ domain: string; /** * Contact roles to repoint to the new WHOIS profile */ change_for: array; }; response: any; // Response structure will depend on the API }; /** * Set WHOIS contact profile as default. The default profile is pre-selected for the TLD it belongs to when registering new domains. Use this endpoint to avoid picking contact information for every registration. */ "domains_whois_set-as-default": { params: { /** * WHOIS ID */ whoisId: number; }; response: any; // Response structure will depend on the API }; /** * Unset WHOIS contact profile as default. The profile itself is kept, it is only no longer pre-selected for its TLD. Use this endpoint to stop reusing contact information for new registrations. */ "domains_whois_unset-default": { params: { /** * WHOIS ID */ whoisId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve a WHOIS contact profile. Use this endpoint to view domain registration contact information. */ "domains_whois_get": { params: { /** * WHOIS ID */ whoisId: number; }; response: any; // Response structure will depend on the API }; /** * Delete WHOIS contact profile. Use this endpoint to remove unused contact profiles from account. */ "domains_whois_delete": { params: { /** * WHOIS ID */ whoisId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve WHOIS contact profiles. Use this endpoint to view available contact profiles for domain registration. */ "domains_whois_list": { params: { /** * Filter by TLD (without leading dot) */ tld?: string; }; response: any; // Response structure will depend on the API }; /** * Create WHOIS contact profile. Use this endpoint to add new contact information for domain registration. */ "domains_whois_create": { params: { /** * TLD of the domain (without leading dot) */ tld: string; /** * ISO 3166 2-letter country code */ country: string; /** * Legal entity type */ entity_type: string; /** * TLD details */ tld_details?: object; /** * WHOIS details */ whois_details: object; }; response: any; // Response structure will depend on the API }; /** * Retrieve domain list where provided WHOIS contact profile is used. Use this endpoint to view which domains use specific contact profiles. */ "domains_whois_usage": { params: { /** * WHOIS ID */ whoisId: number; }; response: any; // Response structure will depend on the API }; /** * List a store's discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100. */ "ecommerce_discounts_list": { params: { /** * The ID of the store to list discounts for. */ store_id: string; /** * Free-text search over discount code and name. */ q?: string; /** * Filter by disabled state. */ is_disabled?: string; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a discount for a store. Fixed discounts take an amount in the smallest currency unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100. Free-shipping discounts ignore value. Returns the created discount. */ "ecommerce_discounts_create": { params: { /** * The ID of the store to create the discount for. */ store_id: string; /** * The discount code customers enter at checkout. */ code: string; /** * A human-friendly discount name. */ name?: string; /** * The discount type. */ type: string; /** * For percentage discounts a whole number 1-100; for fixed discounts an amount in the smallest currency unit (e.g. $10 is 1000). Ignored for free_shipping. */ value: number; /** * Whether the discount applies to the cart total or to each eligible item. */ allocation?: string; /** * When the discount becomes active. A bare date (2026-11-27) anchors to time_zone. Defaults to now when omitted. */ starts_at?: string; /** * When the discount expires. A bare date runs to the end of that day in time_zone. Never expires when omitted. */ ends_at?: string; /** * Maximum number of times the discount can be redeemed. */ usage_limit?: number; /** * Minimum cart value in the smallest currency unit required for the discount to apply. */ min_cart_value?: number; /** * IANA time zone used to interpret starts_at and ends_at. */ time_zone?: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve step-by-step setup instructions, formatted as Markdown, for connecting a custom sales channel to your store and keeping your catalog, orders, shipping and payments in sync through the Ecommerce API. */ "ecommerce_miscellaneous_custom-storefront-setup-instructions": { params: { }; response: any; // Response structure will depend on the API }; /** * Cancel the order and optionally email the customer. Returns the updated order summary. */ "ecommerce_orders_cancel": { params: { /** * The ID of the store that owns the order. */ store_id: string; /** * The ID of the order to cancel. */ order_id: string; /** * Whether to email the customer about the cancellation. Defaults to true. */ notify_customer?: boolean; }; response: any; // Response structure will depend on the API }; /** * Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil every remaining unfulfilled item. Returns the updated order summary. */ "ecommerce_orders_fulfil": { params: { /** * The ID of the store that owns the order. */ store_id: string; /** * The ID of the order to fulfil. */ order_id: string; /** * Line items to fulfil. Omit to fulfil every remaining unfulfilled item. */ items?: array; /** * Carrier tracking number for the shipment. */ tracking_number?: string; /** * Public tracking URL for the shipment. Requires tracking_number. */ tracking_url?: string; /** * Whether to email the customer about the fulfilment. Defaults to true. */ notify_customer?: boolean; }; response: any; // Response structure will depend on the API }; /** * List a store's orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments. */ "ecommerce_orders_list-store": { params: { /** * The ID of the store to list orders for. */ store_id: string; /** * Order statuses to include. */ status?: array; /** * Payment statuses to include. A paid order is "captured". */ payment_status?: array; /** * Fulfilment statuses to include. */ fulfillment_status?: array; /** * Customer email, matched exactly. */ email?: string; /** * The order number the merchant and customer see. */ display_id?: string; /** * Free-text search over customer name, email, order number and line items. */ q?: string; /** * Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC). */ created_at_from?: string; /** * Latest creation time to include, inclusive. A bare date covers that whole day. */ created_at_to?: string; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve one order in full: line items (each with the id the fulfil endpoint needs), addresses, the totals breakdown and fulfilments with tracking. Amounts are in the smallest currency unit. */ "ecommerce_orders_retrieve": { params: { /** * The ID of the store that owns the order. */ store_id: string; /** * The ID of the order to retrieve. */ order_id: string; }; response: any; // Response structure will depend on the API }; /** * Enable a manual payment method so the store can accept orders without an online payment provider. */ "ecommerce_payments_enable-manual-method": { params: { /** * The ID of the store to enable manual payment for. */ store_id: string; /** * Optional display name shown to customers at checkout. */ title?: string; }; response: any; // Response structure will depend on the API }; /** * Create an onboarding link for connecting a payment gateway to the store. Returns the gateway onboarding URL for the merchant to open and a deep-link into the store admin. */ "ecommerce_payments_create-provider-connect-link": { params: { /** * The ID of the store to connect the payment provider to. */ store_id: string; /** * The ID of the payment gateway to connect, e.g. stripe. */ provider_id: string; }; response: any; // Response structure will depend on the API }; /** * List a store's payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration. */ "ecommerce_payments_list-store-providers": { params: { /** * The ID of the store to list payment providers for. */ store_id: string; /** * Include gateways that do not support the store currency in the available list. */ include_currency_unsupported?: boolean; }; response: any; // Response structure will depend on the API }; /** * Returns a signed URL to upload a product image to (multipart/form-data POST). Then call the attach-image endpoint with the returned object_name to scan and attach it to the product. */ "ecommerce_products_create-image-upload-url": { params: { /** * The ID of the store the product belongs to. */ store_id: string; /** * The ID of the product the image will be attached to. */ product_id: string; }; response: any; // Response structure will depend on the API }; /** * Delete a product and its variants from the store. A subscription product with active subscribers is archived instead of deleted so its data stays available. */ "ecommerce_products_delete": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product to delete. */ product_id: string; }; response: any; // Response structure will depend on the API }; /** * Update a product's name, description, status, SEO settings or collections. Set status to published to make it buyable, draft to hide it, or archived to retire it. SEO settings (title, description, slug) left out keep their values. collection_changes adds or removes collections without touching the others. Variants, prices and inventory are managed through the variant endpoints, not here. Returns the updated product summary. */ "ecommerce_products_update": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product to update. */ product_id: string; /** * The product name. */ name?: string; /** * The product description. */ description?: string; /** * Set "published" to make the product buyable, "draft" to hide it, or "archived" to retire it. */ status?: string; /** * Search-engine settings to change. Send at least one field; omitted fields keep their current values. */ seo_settings?: object; /** * Adds the product to or removes it from collections without touching its other collections. Send at least one collection in add or remove. */ collection_changes?: object; }; response: any; // Response structure will depend on the API }; /** * Create a published digital product with a single variant and an optional external download link. */ "ecommerce_products_create-digital": { params: { /** * The ID of the store to create the product in. */ store_id: string; /** * The product name. */ name: string; /** * Price in the smallest currency unit (e.g. cents). Must be positive. */ price: number; /** * The product description. */ description?: string; /** * ISO 4217 currency code. Defaults to the store's default currency when omitted. */ currency?: string; /** * Optional external download link delivered to the customer after purchase. */ download_url?: string; }; response: any; // Response structure will depend on the API }; /** * List a store's products newest first as lean summaries (name, status, thumbnail, variant count and price range). Prices are integers in the smallest currency unit and live on variants. Filter by status, free text or a set of product ids. Use include=variants to embed each product's variants with prices and inventory, and include=media to embed its media. */ "ecommerce_products_list": { params: { /** * The ID of the store to list products for. */ store_id: string; /** * Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids. */ product_ids?: array; /** * Product statuses to include. */ status?: array; /** * Free-text search over product title and SKU. */ q?: string; /** * Opt-in heavy data: "variants" embeds each product's variants; "media" embeds its media. */ include?: array; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a published physical product with a single variant priced in the store currency. */ "ecommerce_products_create-physical": { params: { /** * The ID of the store to create the product in. */ store_id: string; /** * The product name. */ name: string; /** * Price in the smallest currency unit (e.g. cents). Must be positive. */ price: number; /** * The product description. */ description?: string; /** * ISO 4217 currency code. Defaults to the store's default currency when omitted. */ currency?: string; /** * Search-engine settings. Omitted fields are generated from the name and description; a slug already in use gets a numeric suffix. Send at least one field. */ seo_settings?: object; }; response: any; // Response structure will depend on the API }; /** * Fetch a raster image (JPEG, PNG, GIF or WebP, max 15MB) from a URL and attach it to a product in a single call. Image downloads require HTTPS on port 443 without embedded credentials. At most one redirect is allowed, and its destination must meet the same requirements. Private or reserved network destinations, unsupported URLs and longer redirect chains are rejected. The image is virus-scanned and validated by content, then stored on the CDN. Set is_thumbnail to make it the product's primary image. */ "ecommerce_products_upload-and-attach-image": { params: { /** * The ID of the store the product belongs to. */ store_id: string; /** * The ID of the product to attach the image to. */ product_id: string; /** * Publicly reachable URL of a raster image (JPEG, PNG, GIF or WebP), maximum 15MB. Fetching the image requires HTTPS on port 443 without embedded credentials. At most one redirect is allowed; its destination must meet the same URL requirements. Private or reserved network destinations, unsupported URLs and longer redirect chains are rejected. The image is fetched, virus-scanned and validated by content, then stored on the CDN. SVG is not accepted. Provide either this or object_name. */ image_url?: string; /** * Key returned by the upload-url endpoint. Provide this instead of image_url to attach an uploaded image. */ object_name?: string; /** * When true, the image becomes the product's thumbnail (primary image). When omitted, it becomes the thumbnail only if the product does not have one yet. */ is_thumbnail?: boolean; }; response: any; // Response structure will depend on the API }; /** * List a store's active sales channels with their full metadata. */ "ecommerce_sales-channels_list": { params: { /** * The ID of the store to list sales channels for. */ store_id: string; }; response: any; // Response structure will depend on the API }; /** * Create a sales channel for a store. A "custom" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A "quick-link" channel is a hosted one-page store whose handle is auto-generated. */ "ecommerce_sales-channels_create": { params: { /** * The ID of the store to create the sales channel for. */ store_id: string; /** * Sales channel type. "custom" is a headless channel: it requires a name and takes an optional public url. "quick-link" is a one-page store whose handle is auto-generated; it supports neither name nor url. */ type: string; /** * Merchant-facing custom name. Required for custom channels; not supported for quick-link. */ name?: string; /** * Optional public url for the channel. Custom channels only; not supported for quick-link. */ url?: string; }; response: any; // Response structure will depend on the API }; /** * Update a custom sales channel. The merchant-facing `name` and the public `url` (returned as the channel `domain`) can be changed. Pass `null` to clear a value. */ "ecommerce_sales-channels_update": { params: { /** * The ID of the store that owns the sales channel. */ store_id: string; /** * The ID of the sales channel to update. */ sales_channel_id: string; /** * Merchant-facing custom name shown in the sales channels list. Pass null to clear it. */ name?: string; /** * Public address where the custom sales channel lives. Pass null to clear it. */ url?: string; }; response: any; // Response structure will depend on the API }; /** * Set the flat-rate shipping price for a store, creating the shipping zone if it does not exist yet. */ "ecommerce_shipping_set-store": { params: { /** * The ID of the store to configure shipping for. */ store_id: string; /** * Flat shipping rate in the smallest currency unit (e.g. cents). Use 0 for free shipping. */ price: number; }; response: any; // Response structure will depend on the API }; /** * Soft-delete a store owned by your account. The underlying store data is preserved; only the store is marked as deleted. */ "ecommerce_stores_delete": { params: { /** * The ID of the store to delete. */ store_id: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve the stores associated with your account. */ "ecommerce_stores_list": { params: { /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a new store for your account. A primary sales channel is created alongside the store. */ "ecommerce_stores_create": { params: { /** * name parameter */ name?: string; /** * ISO 3166-1 alpha-2 country code. */ country_code?: string; /** * company_email parameter */ company_email?: string; /** * company_name parameter */ company_name?: string; /** * ISO 639-1 language code. */ language?: string; /** * sales_channel parameter */ sales_channel?: object; }; response: any; // Response structure will depend on the API }; /** * Get a store's readiness metadata: whether payment methods and shipping are configured, plus its default currency. Useful to verify prerequisites before building a storefront. */ "ecommerce_stores_metadata": { params: { /** * The ID of the store to read metadata for. */ store_id: string; }; response: any; // Response structure will depend on the API }; /** * Update up to 100 existing variants in place by id — title, SKU, inventory, stock tracking and prices. Variants omitted from the request are left untouched. Prices replace the variant's existing prices in full. Returns the updated variants. */ "ecommerce_product-variants_update-in-batch": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product whose variants are being updated. */ product_id: string; /** * Variants to update in place by id, up to 100. Variants omitted from the list are left untouched. */ variants: array; }; response: any; // Response structure will depend on the API }; /** * Delete a single variant from the product. */ "ecommerce_product-variants_delete": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product that owns the variant. */ product_id: string; /** * The ID of the variant to delete. */ variant_id: string; }; response: any; // Response structure will depend on the API }; /** * List a product's variants, ordered by rank, with their options, prices and inventory. Prices are integers in the smallest currency unit and live on variants. */ "ecommerce_product-variants_list": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product to list variants for. */ product_id: string; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Add a variant to a product along one or more option dimensions (e.g. Size, Color). Options missing from the product are created automatically; provide a value for every option the product already has. Prices are integers in the smallest currency unit and default to the store currency. Returns the created variant. */ "ecommerce_product-variants_create": { params: { /** * The ID of the store that owns the product. */ store_id: string; /** * The ID of the product to add the variant to. */ product_id: string; /** * The variant title. Defaults to the option values joined with ' / ' (e.g. 'Red / L'). */ title?: string; /** * The variant SKU. */ sku?: string; /** * Option name/value pairs that distinguish this variant, e.g. [{name: Size, value: M}]. Options missing from the product are created; provide a value for every option the product already has. */ options: array; /** * Prices per currency. Amounts are integers in the smallest currency unit. A free item is amount: 0. */ prices?: array; /** * Units in stock. Defaults to 0. */ inventory_quantity?: number; /** * Whether stock is tracked for this variant. Defaults to false. */ manage_inventory?: boolean; }; response: any; // Response structure will depend on the API }; /** * Clone a Hostinger Horizons website into a new website.\n Use this tool when the user wants a copy of an existing website, for example to try out changes without touching the original.\n This tool returns the ID and URL of the newly created copy. The original website is left untouched.\n To edit the copy, use the `Edit website` tool with the returned website ID, or the user can open the provided website URL in Hostinger Horizons interface. */ "horizons_websites_clone": { params: { /** * The website ID */ websiteId: string; }; response: any; // Response structure will depend on the API }; /** * List the Hostinger Horizons websites the user owns.\n Use this tool when the user asks which websites they have, or when you need a website ID before editing, publishing or cloning a website.\n Each website is returned with its ID, status, domain and the URL to open it in Hostinger Horizons interface.\n The complete list of websites is returned in a single response - it is not paginated. */ "horizons_websites_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Create new Hostinger Horizons website from the given message.\n Use this tool when user asks you to create a website, landing page, blog or any other type of application.\n This tool initiates the website creation process and returns a website URL and ID. The generation happens asynchronously.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that Hostinger Horizons is now creating their website and it will be ready in a few minutes and you should provide the website URL to the user immediately Do not write code.\n\nTo edit afterwards, use the `Edit website` tool with the returned website ID, or the user can go to Hostinger Horizons interface in the provided website URL. If the tool call fails with an error, you should provide a clear explanation of the error and do not generate code yourself in the chat. \n TECHNOLOGY STACK CONSTRAINTS (STRICTLY ENFORCED):\n The environment is limited to the following technologies. You MUST NOT use, suggest, or implement any technology outside this list:\n \n - Language: JavaScript ONLY. - Languages like TypeScript, Rust, Python, Java, PHP, etc., are STRICTLY PROHIBITED.\n - Framework: React.\n - Navigation: React Router.\n - Styling: TailwindCSS.\n - Components: shadcn/ui (built with @radix-ui primitives).\n - Icons: Lucide React.\n - Animations: Framer Motion.\n \n BACKEND & DATA STORAGE:\n - Horizons integrated backend is the EXCLUSIVE solution for persistent data storage, authentication, and database needs.\n - Local databases (SQLite, MySQL, etc.) are STRICTLY PROHIBITED.\n - Third-party services (Firebase, AWS Amplify) are allowed ONLY if explicitly requested by the user.\n \n MAPS:\n - OpenStreetMap is the default provider.\n - Alternative providers (Google Maps, Mapbox) are allowed ONLY if explicitly requested by the user.\n */ "horizons_websites_create": { params: { /** * message parameter */ message: array; }; response: any; // Response structure will depend on the API }; /** * Edit an existing Hostinger Horizons website with a follow-up message.\n Use this tool when the user wants to change, extend or fix a website that already exists.\n This tool queues the requested changes and returns the website URL and ID. The changes are applied asynchronously.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that Hostinger Horizons is now applying the requested changes and they will be ready in a few minutes, and you should provide the website URL to the user immediately. Do not write code.\n If the tool call fails with an error, you should provide a clear explanation of the error and do not generate code yourself in the chat. */ "horizons_websites_edit": { params: { /** * The website ID */ websiteId: string; /** * message parameter */ message: array; }; response: any; // Response structure will depend on the API }; /** * Publish a Hostinger Horizons website so its latest changes go live.\n Use this tool when the user asks to publish, deploy or make their website live.\n This tool starts the publish process and returns the URL the website will be live on. Publishing happens asynchronously and takes a few minutes.\n Set `is_template` only when the user explicitly asks to share the website as a template: true adds a "Use template" banner to its published pages that copies the website into the visitor's own account, and false removes it. Leave it out to keep the current setting.\n After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing that the website is being published and you should provide the published URL to the user immediately. */ "horizons_websites_publish": { params: { /** * The website ID */ websiteId: string; /** * Set to true to publish the website as a template: its published pages show a "Use template" banner that copies the website into the visitor's own account. Set to false to remove the banner. Leave it out to keep the current setting. */ is_template?: boolean; }; response: any; // Response structure will depend on the API }; /** * Get the link for the user to open their website in Hostinger Horizons interface.\n Use this tool when the user wants the link to an existing website, or when you need its website URL before or after editing it.\n `is_in_progress` is true while changes are being generated or the website is being published; wait until it is false before publishing. `published_at` is when the website was last published, `is_template` is whether its published pages show the "Use template" banner, and `has_ecommerce_store` is whether it has an online store.\n Websites can be edited with the `Edit website` tool, or by the user in Hostinger Horizons interface in the provided website URL. */ "horizons_websites_get": { params: { /** * The website ID */ websiteId: string; }; response: any; // Response structure will depend on the API }; /** * Permanently clears all server-side cache for the website at once. Use it when content was updated and needs to be visible immediately, or after making major changes. Also purges the Hostinger CDN cache when CDN is enabled on the website. To purge only the CDN cache and leave the server cache untouched, use `Purge CDN cache`. For a WordPress installation living in a subdirectory, pass the directory query parameter to clear its cache. */ "hosting_cache_clear-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Directory of the website installation to clear, relative to the website root. Defaults to the website root. */ directory?: string; }; response: any; // Response structure will depend on the API }; /** * Turns development (cacheless) mode on or off, based on the enabled flag. When enabled, nothing is cached, effectively turning off all caching for the website; use it while actively developing, testing changes, debugging issues, or when real-time updates must be visible. Disable it after finishing development work to restore the performance benefits of caching. */ "hosting_cache_toggle-cacheless": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Turn development (cacheless) mode on (true) or off (false) for the website. */ enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Turns server-side caching for the website on or off, based on the enabled flag. Enable it for faster page loads, reduced server load, and improved user experience; recommended for production websites. Disabling may impact performance; to temporarily bypass caching while developing or debugging, prefer toggling cacheless mode instead. Does nothing if caching is already in the requested state. */ "hosting_cache_toggle-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Turn server-side caching on (true) or off (false) for the website. */ enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Turns off the Hostinger CDN for the website domain. Once DNS propagation completes, the website content is served directly from the origin server. Repeating the call is safe; when CDN is already disabled, it applies the DNS change again. Returns 422 for platform-managed domains (for example `*.hostingersite.com` and `*.app-preview.com`), where CDN cannot be disabled, even when CDN is already off. Also returns 422 while the account is being moved to another server (retry after the move finishes), or when the CDN provider rejects the change. Returns 404 when the domain is not a website on the account. */ "hosting_cdn_disable": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Turns on the Hostinger CDN for the website domain, which speeds up page loads and reduces the load on the server. Works for the main domain, parked domains and subdomains of the account. Enabling changes the domain's DNS records and usually takes a few seconds. After that, DNS propagation can take a few more minutes before visitors are served through the CDN. Repeating the call is safe, for example after a timeout. When CDN is already enabled, it applies the DNS change again and refreshes the CDN SSL certificate. Returns 422 when the account is disabled, while the account is being moved to another server (retry after the move finishes), or when the CDN provider rejects the change. Returns 404 when the domain is not a website on the account. */ "hosting_cdn_enable": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Purges the website's content from the Hostinger CDN edge cache only. The origin server cache is not touched; to clear both, use `Clear website cache`. Returns 422 when CDN is not enabled on the website. Returns 404 when the domain is not a website on the account. */ "hosting_cdn_purge-cache": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns whether the Hostinger CDN is enabled for the website domain. Works for the main domain, parked domains and subdomains of the account. The domain must be the exact website name as listed on the account, without a `www.` prefix. Returns 404 when the domain is not a website on the account. */ "hosting_cdn_status": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the list of cron jobs configured for the specified account, including their schedule and command. */ "hosting_cron-jobs_list": { params: { /** * username parameter */ username: string; }; response: any; // Response structure will depend on the API }; /** * Creates a cron job for the specified account from a schedule expression and a command. Returns the created cron job, including its uid, which is required to delete the cron job or fetch its output. */ "hosting_cron-jobs_create": { params: { /** * username parameter */ username: string; /** * Cron schedule expression (for example "0 2 * * *" runs daily at 02:00). */ time: string; /** * Command to execute on the schedule. */ command: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes the cron job identified by its uid. The uid is returned by the list cron jobs endpoint. */ "hosting_cron-jobs_delete": { params: { /** * username parameter */ username: string; /** * Unique identifier of the cron job as returned by the list cron jobs endpoint. */ uid: string; }; response: any; // Response structure will depend on the API }; /** * Returns the output captured from the last execution of the cron job identified by its uid. The uid is returned by the list cron jobs endpoint. */ "hosting_cron-jobs_output": { params: { /** * username parameter */ username: string; /** * Unique identifier of the cron job as returned by the list cron jobs endpoint. */ uid: string; }; response: any; // Response structure will depend on the API }; /** * Changes the password for the specified database user. The database name must be the full name returned by the list databases endpoint. The password must also be updated in any website configuration that uses this database. */ "hosting_databases_change-password": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; /** * New database user password. */ password: string; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of databases for the specified account. Use the domain and is_assigned filters to find databases assigned to a specific domain. */ "hosting_databases_list": { params: { /** * username parameter */ username: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Filter by domain name (case-insensitive substring match) */ domain?: string; /** * When used with domain, return only databases assigned to that domain. */ is_assigned?: boolean; /** * Search databases by name, user, or creation date. */ search?: string; }; response: any; // Response structure will depend on the API }; /** * Creates a database with a database user and password for the specified account. The database name and user are automatically prefixed with the account username when needed. */ "hosting_databases_create": { params: { /** * username parameter */ username: string; /** * Database name. If the account username prefix is omitted, it is added automatically. */ name: string; /** * Database user. If the account username prefix is omitted, it is added automatically. */ user: string; /** * Database user password. */ password: string; /** * Website domain assigned to the database. */ website_domain: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes a database and its remote connections. The database name must be the full name returned by the list databases endpoint. */ "hosting_databases_delete": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; }; response: any; // Response structure will depend on the API }; /** * Allows a remote host to connect to the specified database. Provide an IPv4/IPv6 address, or "%" to allow any host. The database name must be the full name returned by the list databases endpoint. Database creation is synchronous, so a 404 here means no database with that name exists under the username, not that it is still being created. */ "hosting_databases_create-remote-connection": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; /** * Remote host to allow: an IPv4/IPv6 address, or "%" for any host. */ ip: string; }; response: any; // Response structure will depend on the API }; /** * Permanently removes a remote-access rule, revoking the given host's remote access to the database. Identify the rule with the required ip query parameter (the IPv4/IPv6 address, or "%", exactly as returned by the list remote connections endpoint). The database name must be the full name returned by the list databases endpoint. */ "hosting_databases_delete-remote-connection": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; /** * Remote host to revoke: the IPv4/IPv6 address, or "%", exactly as returned by the list remote connections endpoint. */ ip: string; }; response: any; // Response structure will depend on the API }; /** * Returns the remote-access rules for the specified account: the remote hosts (IPv4/IPv6 addresses, or "%" for any host) allowed to connect to the account databases. Use the domain filter to only return rules for databases assigned to a specific domain. */ "hosting_databases_list-remote-connections": { params: { /** * username parameter */ username: string; /** * Filter remote connections by the domain the database is assigned to. Rules for databases not assigned to any domain are always included. */ domain?: string; }; response: any; // Response structure will depend on the API }; /** * Repairs corrupted database tables asynchronously. Use when database errors, crashes, or corruption are reported. The database name must be the full name returned by the list databases endpoint. */ "hosting_databases_repair": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; }; response: any; // Response structure will depend on the API }; /** * Creates a new MySQL database for the website and writes its connection details into the website's environment variables, then restarts the application. The platform generates the password (and the database name and user, unless supplied). The password is never returned; the application reads it from the environment. Written variables: `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD` and `DATABASE_URL` (`mysql://user:password@host:port/name`, user and password percent-encoded). Existing variables are kept. If the website already has any variable with one of these names the call fails with 422 and nothing is created; the `Replace Node.js environment variables` endpoint removes them. After this call the variables are ordinary environment variables: the `Replace Node.js environment variables` endpoint changes or removes them like any other. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. Frameworks that bake variables into the build output (Next.js, `NEXT_PUBLIC_*`) see the new values only after a fresh build (`Start Node.js build` endpoint). A password in the request is ignored; the platform always generates it. The optional `name` and `user` are identifiers, not secrets. */ "hosting_databases_setup-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Optional database name. Generated when omitted. Letters, digits and underscores; must not start with an underscore. Up to 14 characters without the account username prefix (`u123456789_`), which is added automatically when missing. With the prefix the full name is 12 to 25 characters. */ name?: string; /** * Optional database user. Generated when omitted. Letters, digits and underscores; must not start with an underscore. Up to 14 characters without the account username prefix (`u123456789_`), which is added automatically when missing. With the prefix the full user is 12 to 25 characters. */ user?: string; }; response: any; // Response structure will depend on the API }; /** * Returns a direct sign-on link to phpMyAdmin for the specified database. Use this when a visual database interface is needed for SQL queries, imports, exports, or table management. The database name must be the full name returned by the list databases endpoint. */ "hosting_databases_phpmyadmin-link": { params: { /** * username parameter */ username: string; /** * Full database name as returned by the list databases endpoint. */ name: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a list of datacenters available for setting up hosting plans based on available datacenter capacity and hosting plan of your order. The first item in the list is the best match for your specific order requirements. */ "hosting_datacenters_list": { params: { /** * Order ID */ order_id: number; }; response: any; // Response structure will depend on the API }; /** * Generate a unique free subdomain that can be used for hosting services without purchasing custom domains. Free subdomains allow you to start using hosting services immediately and you can always connect a custom domain to your site later. */ "hosting_domains_generate-free-subdomain": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieve all parked or alias domains created under the selected website. Use this endpoint to inspect parked domain configuration for a specific website, including the parent domain and root directory assigned to each parked domain. */ "hosting_domains_list-website-parked": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Create a parked or alias domain for the selected website. Provide a domain name or IP address to park on the website so it serves the same content as the parent domain. */ "hosting_domains_create-website-parked": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Domain name or IP address to park on the selected website */ parked_domain: string; }; response: any; // Response structure will depend on the API }; /** * Delete an existing parked or alias domain from the selected website. Use this endpoint to remove parked domains that are no longer needed. */ "hosting_domains_delete-website-parked": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * parkedDomain parameter */ parkedDomain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all subdomains created under the selected website. Use this endpoint to inspect subdomain configuration for a specific website, including the parent domain and root directory assigned to each subdomain. */ "hosting_domains_list-website-subdomains": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Create a new subdomain for the selected website. Provide a subdomain prefix and, optionally, a custom directory or the website public directory to use as the subdomain root. */ "hosting_domains_create-website-subdomain": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Subdomain prefix to create under the selected website */ subdomain: string; /** * Directory name for the subdomain relative to the website root */ directory?: string; /** * Use the website public directory as the subdomain root directory */ is_using_public_directory?: boolean; }; response: any; // Response structure will depend on the API }; /** * Delete an existing subdomain from the selected website. Use this endpoint to remove subdomains that are no longer needed. */ "hosting_domains_delete-website-subdomain": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * subdomain parameter */ subdomain: string; }; response: any; // Response structure will depend on the API }; /** * Verify ownership of a single domain and return the verification status. Use this endpoint to check if a domain is accessible for you before using it for new websites. If the domain is accessible, the response will have `is_accessible: true`. If not, add the given TXT record to your domain's DNS records and try verifying again. Keep in mind that it may take up to 10 minutes for new TXT DNS records to propagate. Skip this verification when using Hostinger's free subdomains (*.hostingersite.com). */ "hosting_domains_verify-ownership": { params: { /** * Domain to verify ownership for */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Generate a file browser upload URL with authentication credentials for uploading files directly to a website's file storage. While the website is still being set up (`status: running` on the list website setups endpoint) this endpoint returns 409 with a `Retry-After` header: wait that many seconds and retry, or poll the website setups until the status is `completed`. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website's `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux curl -i -X POST "{url}/${FILE}?override=true" \ -H "X-Auth: {auth_key}" \ -H "X-Auth-Rest: {rest_auth_key}" \ -H "Tus-Resumable: 1.0.0" \ -H "Upload-Length: ${SIZE}" \ -H "Upload-Offset: 0" # -> 201 Created curl -i -X PATCH "{url}/${FILE}?override=true" \ -H "X-Auth: {auth_key}" \ -H "X-Auth-Rest: {rest_auth_key}" \ -H "Tus-Resumable: 1.0.0" \ -H "Content-Type: application/offset+octet-stream" \ -H "Upload-Offset: 0" \ --data-binary "@${FILE}" # -> 204 No Content, Upload-Offset response header equals SIZE when done ``` */ "hosting_files_generate-upload-url": { params: { /** * Account username */ username: string; /** * Website domain */ domain: string; }; response: any; // Response structure will depend on the API }; /** * List files and directories under a website's document root. Use `directory` to browse a subdirectory relative to the document root. Symlinked entries are listed but never traversed into or resolved. */ "hosting_files_list-website-and-directories": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Directory path to check */ directory?: string; /** * How many directory levels deep to recurse. */ max_depth?: number; /** * Max number of entries to return in this page. */ max_items?: number; /** * Number of entries to skip. Page with offset + item count until reaching total_items. */ offset?: number; /** * Filter by entry type, e.g. file,directory. Omit for all types. */ file_types?: array; }; response: any; // Response structure will depend on the API }; /** * Get a single file's content, relative to a website's document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint. */ "hosting_files_website-content": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * File path, relative to the document root. */ path: string; /** * Line offset to start reading from. */ from_line?: number; /** * Max number of lines to return. */ max_lines?: number; }; response: any; // Response structure will depend on the API }; /** * Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`. */ "hosting_git_auto-deployment-settings": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website. */ "hosting_git_update-auto-deployment-settings": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Active Git installation from `List Git installations` */ installation_uuid: string; /** * Repository owner login, as returned by `List Git installation repositories`. GitLab group paths use slashes. */ owner: string; /** * Repository name without the .git suffix */ repository: string; /** * Branch to deploy */ branch: string; /** * Subdirectory under the website document root to deploy into. Empty, null or omitted means the document root. */ directory?: string; /** * Whether pushes to the branch deploy automatically */ is_enabled?: boolean; }; response: any; // Response structure will depend on the API }; /** * Removes the Git auto-deployment settings of the website. Files already deployed stay on the website; pushes stop deploying until settings are saved again. Succeeds also when nothing is configured. */ "hosting_git_delete-auto-deployment-settings": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, a Git provider (GitHub or GitLab) has to be connected once in hPanel (Websites, Manage, Advanced, Git; or Add Website, Node.js Web App, Import Git Repository); this endpoint then lists the new installation. Use `uuid` as the path parameter of `List Git installation repositories`, and as `installation_uuid` in `Start Node.js build` with `source_type` `git` and in `Update Git auto-deployment settings`. */ "hosting_git_list-installations": { params: { /** * Filter by Git provider */ provider?: string; /** * Filter by installation status */ status?: string; }; response: any; // Response structure will depend on the API }; /** * Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that). */ "hosting_git_list-installation-repositories": { params: { /** * Git installation UUID from the List Git installations endpoint */ uuid: string; }; response: any; // Response structure will depend on the API }; /** * Clones a Git repository into a directory of the website, or pulls it again. An empty or missing directory gets a clone of the branch. A directory that already holds this repository and branch is reset to its last commit and pulled: changes made on the server to files the repository tracks are discarded, files it does not track stay. A directory that holds other files, including another repository or another branch of this one, is rejected. `composer install` runs after the clone or pull when the repository has a `composer.json`. The call waits for the deployment and returns its log. `is_success` false means Git or composer failed and the log says why. A second call for the same directory is rejected while the first is still waiting for the server. If the request times out, the deployment may still finish on the server; calling again later with the same repository and branch pulls. Private repositories need an SSH URL and the account's Git SSH key from `Generate Git SSH key`, added to the repository as a deploy key. */ "hosting_git_deploy-website-repository": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Clone URL of the repository on any Git host, SSH or HTTPS. Private repositories need an SSH URL and the account's Git SSH key added to the repository as a deploy key. An HTTP or HTTPS URL with a username or token, or any URL with a password, is rejected. */ repository_url: string; /** * Branch to clone and pull */ branch: string; /** * Directory under the website document root, exactly as `List website Git repositories` returns it for an existing repository. Empty, null or omitted means the document root. */ directory?: string; }; response: any; // Response structure will depend on the API }; /** * Lists the Git repositories linked to directories of the website, with `Deploy website Git repository` or in the Git section of hPanel: clone URL, branch and directory of each one. A repository whose clone failed stays listed; deploying it again retries the clone. GitHub and GitLab auto-deployments are not listed here; see `Get Git auto-deployment settings`. */ "hosting_git_list-website-repositories": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the public SSH key of the hosting account. `Deploy website Git repository` uses this key to clone and pull over SSH, so a private repository works once the key is added to it as a deploy key on the Git host. `public_key` is null when the account has no key yet. */ "hosting_git_ssh-public-key": { params: { /** * username parameter */ username: string; }; response: any; // Response structure will depend on the API }; /** * Creates the SSH key pair of the hosting account and returns the public key. When the account already has a key, returns that key unchanged. One key serves every website of the account; add the public key to a private repository as a deploy key before deploying it. */ "hosting_git_generate-ssh-key": { params: { /** * username parameter */ username: string; }; response: any; // Response structure will depend on the API }; /** * Submits the build report the headless skill writes at the end of a run (including early stops), so Hostinger can learn where builds get stuck. Send one report per call, with the report JSON as the request body, unchanged. Only send a report when the user agreed to it. The report must match report.schema.json v1; an invalid report returns 422 and is not stored. The report is linked to the authenticated account, so do not add account details to it. */ "hosting_headless_submit-build-report": { params: { /** * Report schema version */ schema_version: string; /** * When the report was written */ generated_at: string; /** * Upload status of the report, as written by the headless skill */ consent: object; /** * The run the report is for */ run: object; /** * Website, tool and outcome of the run */ info: object; /** * Run start and end times and per-stage timings */ timing: object; /** * Token usage, only when the tool reports its own usage */ tokens: object; /** * Problems hit during the run */ issues: array; /** * Feedback the user gave during the run */ user_feedback: array; /** * Places where the skill instructions were missing or wrong */ skill_gaps: array; /** * Things that worked well during the run */ what_went_well: array; /** * Where the run log is missing or unsure */ logging_gaps?: array; /** * Earlier runs for the same website */ previous_runs: array; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint. */ "hosting_nodejs_list-builds": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Build states to filter by */ states?: array; }; response: any; // Response structure will depend on the API }; /** * Start a Node.js build process using files already present on the website's file storage. WARNING: on success this overwrites the website's existing contents and cannot be undone — verify this is intended before calling this endpoint. With `source_type` `archive`, `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. With `source_type` `git`, `source_options` carries `owner`, `repository`, `branch` and `installation_uuid`. Take the installation from `List Git installations` and the owner and repository from `List Git installation repositories`; the branch is cloned at its current head. The installation must belong to the same customer as the website. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint. */ "hosting_nodejs_start-build": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Node.js version */ node_version: number; /** * Node.js application type */ app_type: string; /** * Application root directory (where package.json is located) relative to public_html */ root_directory: string; /** * Build output directory relative to the root directory */ output_directory: string; /** * Build script that will be ran to build the application */ build_script: string; /** * The main entry point file for the application */ entry_file?: string; /** * Package manager */ package_manager?: string; /** * Where the files come from: `archive` (an uploaded archive on the website) or `git` (a branch of a repository reachable through a Git installation). */ source_type: string; /** * Source-specific options. For `archive` send `archive_path`. For `git` send `owner`, `repository`, `branch` and `installation_uuid`, taken from `List Git installations` and `List Git installation repositories`. */ source_options: object; }; response: any; // Response structure will depend on the API }; /** * Returns the build settings stored for the website: framework (`app_type`), Node.js version, root and output directory, build script, entry file and package manager. Stored settings drive Git auto-deployment builds. A build started through the API uses the values sent in that request and saves them here only when no settings exist yet. Returns 404 until the first build or the first settings update stores them. Use this after a failed build to check whether the framework or the entry file were detected wrong, then fix them with the `Update Node.js build settings` endpoint. */ "hosting_nodejs_build-settings": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Replaces the build settings stored for the website. Send the full set: `node_version` is required and every nullable field you omit is stored as null. Creates the settings when none exist yet. This does not start a build. Stored settings drive Git auto-deployment builds; a build started through the API uses the values sent in that request, so to rebuild with corrected settings call `Start Node.js build` with the same values. Typical fixes: a wrong `app_type` after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono apps. */ "hosting_nodejs_update-build-settings": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Node.js major version */ node_version: number; /** * Node.js application framework. Set it explicitly when auto-detection picked the wrong one. */ app_type?: string; /** * Application root directory (where package.json is located) relative to public_html. Omit it, or send ".", for public_html itself. */ root_directory?: string; /** * Build output directory relative to the root directory */ output_directory?: string; /** * The package.json script that builds the application */ build_script?: string; /** * The main entry point file for the application (required for express, fastify, nest, nuxt and hono app types) */ entry_file?: string; /** * Package manager used to install dependencies */ package_manager?: string; }; response: any; // Response structure will depend on the API }; /** * Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website's file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. */ "hosting_nodejs_build-settings-from-archive": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * The path to the archive file relative to the document root of the vhost */ archive_path: string; }; response: any; // Response structure will depend on the API }; /** * Determine the build settings for a Node.js application from the package.json file of a branch in a Git repository. Use before starting a Git-source build to find out the auto-detected settings instead of guessing them. The repository is read through a Git installation: take `installation_uuid` from `List Git installations` and `owner` and `repository` from `List Git installation repositories`. Returns 422 when the installation is not found, the repository or branch is not found, or the branch has no package.json. */ "hosting_nodejs_build-settings-from-repository": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Repository owner login. GitLab group paths use slashes. */ owner: string; /** * Repository name without the .git suffix */ repository: string; /** * Branch whose package.json is inspected */ branch: string; /** * Git installation used to access the repository, taken from `List Git installations` */ installation_uuid: string; }; response: any; // Response structure will depend on the API }; /** * Lists the Node.js environment variables currently set for the website. Values are always masked as `********` and cannot be read back through this API. Use this endpoint to see which keys are configured or to verify a change, not to read values. To change variables, use the `Replace Node.js environment variables` endpoint. It replaces the whole set, so never copy the masked values from this response into that request; send the full desired set with real values taken from the project `.env` file or the user prompt instead. */ "hosting_nodejs_list-environment-variables": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Replaces the website's Node.js environment variables with the ones provided. This is a full replace: any variable not in the request is deleted, and sending an empty `env_vars` array deletes every variable. Saving writes the values and restarts the running Node.js process. A restart is enough for apps that read environment variables at process start, such as Express or NestJS. It is not enough for frameworks that bake variables into the build. Next.js standalone is one of those: build-time values (including `NEXT_PUBLIC_*`) need a fresh build. After this call, use the `Start Node.js build` endpoint so those apps pick up the new values. The `List Node.js environment variables` endpoint returns masked values (`********`), so never copy values from it into this request. Always send the full desired set with real values taken from the project `.env` file or the user prompt. */ "hosting_nodejs_replace-environment-variables": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Environment variables to set. This is the full desired set: any variable not in this list is deleted, and an empty array deletes every variable. */ env_vars: array; }; response: any; // Response structure will depend on the API }; /** * Returns an AI analysis of why a build failed and how to fix it, based on the build logs, the project file list and package.json. Only builds in the `failed` state can be analysed; any other state returns 422. When no analysis could be produced both `analysis` and `solution` are null, in which case read `Get NodeJS build logs` instead. Each call runs the analysis again, so call it once per failed build and keep the result. Limited to 5 calls per minute per API client (429 above that). */ "hosting_nodejs_analyse-failed-build": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Build UUID */ uuid: string; }; response: any; // Response structure will depend on the API }; /** * Returns one build by UUID: its state (`pending`, `running`, `completed`, `failed`), the options it ran with and timestamps. Poll this while a build is pending or running. When it is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause. Returns 404 when the UUID does not belong to a build of this website. */ "hosting_nodejs_build": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Build UUID */ uuid: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve logs from a specific Node.js build process. To stream live output while a build is running, poll this endpoint repeatedly while the build state is `running`, passing the previously returned `lines` count as `from_line` to fetch only new output since the last call. Log content may contain ANSI escape sequences (color codes). */ "hosting_nodejs_build-logs": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Build UUID */ uuid: string; /** * Line from which to start retrieving logs */ from_line?: number; }; response: any; // Response structure will depend on the API }; /** * Returns the Node.js application's runtime console log entries, oldest first, each with timestamp, level and message. On the first call send `period` (`1h`, `1d`, `1w` or `1m`) and optionally `levels` and `limit` (1-5000, default 1000); when more entries match than `limit`, the newest are kept. To poll for new entries send `total_lines + 1` from the previous response as `from_line` and omit `period`; `period` and `from_line` cannot be combined. Lines that are not JSON with a timestamp, level and message are skipped, so `logs` may hold fewer than `limit` entries while `total_lines` counts every raw line. Entries with a timestamp before `last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when the application has not written a log file yet. */ "hosting_nodejs_runtime-logs": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Time window for the first fetch. Required when `from_line` is not sent. */ period?: string; /** * 1-based line of the log file to start from. For polling send `total_lines + 1` from the previous response. Cannot be combined with `period`. */ from_line?: number; /** * Maximum number of log entries to return. When more entries match, the newest are kept. */ limit?: number; /** * Return only entries with these log levels, sent as a comma-separated list, e.g. ERROR,WARN. Matching runs on the raw log line, so entries written with numeric levels (for example by pino) are excluded while this filter is set. */ levels?: array; }; response: any; // Response structure will depend on the API }; /** * Empties the Node.js application's runtime log file. This cannot be undone, so confirm with the user before calling it. Returns success even when no log file exists yet. Use it before reproducing a problem so the next `Get Node.js runtime logs` call returns only fresh entries; start that call with `period` again instead of reusing a `from_line` from before the clear. */ "hosting_nodejs_clear-runtime-logs": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Restarts the Node.js server process for the website. Does not rebuild or redeploy the application. Use it to apply environment or configuration changes, or to recover a hung application. Only applicable to server-side applications (Express, Next.js, NestJS, etc.). Static front-end apps (React, Vue, Vite) have no persistent server process, so restarting them has no effect. Returns success even when the website has no server process to restart. */ "hosting_nodejs_restart-application": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Lists known npm package vulnerabilities detected on a Node.js website, enriched with advisory metadata (severity, CVSS score, CVE, advisory URL). Results are sorted from the most severe to the least severe, then by publish date (newest first). Use the `severities` query parameter to filter. Vulnerabilities with `is_patchable` set to `true` can be auto-fixed via the `Patch Node.js Vulnerabilities` endpoint, which opens a GitHub pull request with updated package versions. Auto-fix is only available for websites deployed from a connected GitHub repository. Vulnerabilities with `is_patching_in_progress` set to `true` are already included in an open patch pull request; while any patch pull request is open, new patch requests for this website are rejected until it is merged or closed. Data comes from periodic dependency scans, so it may lag behind the latest deployment. An empty list means the most recent scan found no vulnerabilities; it does not guarantee the current deployment is vulnerability-free. Available on Business and Cloud Hosting plans. */ "hosting_nodejs_list-vulnerabilities": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Severities to filter by */ severities?: array; }; response: any; // Response structure will depend on the API }; /** * Patches the selected Node.js vulnerabilities by updating the affected package versions in `package.json` and opening a GitHub pull request in the connected repository. The customer reviews and merges the pull request; merging triggers the automatic deployment. Auto-fix is only available for websites deployed from a connected GitHub repository. Websites deployed from an archive have no auto-fix path and return a 404. The Hostinger GitHub App needs write access to the repository; without it the request fails with a 403 explaining the missing permission. Only vulnerabilities with `is_patchable` set to `true` can be patched. Non-patchable IDs in the selection are skipped; the pull request covers the patchable subset, listed in `patched_vulnerability_ids`. Selections without any patchable vulnerability are rejected with a 422. Only one patch pull request can be open at a time per website; close or merge it before patching again. Available on Business and Cloud Hosting plans. */ "hosting_nodejs_patch-vulnerabilities": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * List of vulnerability IDs to patch, as returned by the list vulnerabilities endpoint. */ vulnerability_ids: array; }; response: any; // Response structure will depend on the API }; /** * Returns the website setups started in the last 24 hours for the hosting accounts accessible to the authenticated client, newest first. Narrow the list with the `order_id`, `subscription_id` or `domain` filters. Meant for polling right after creating a website or starting a website setup: the website shows up in the websites list before its server-side setup has finished, and while the setup is `running` endpoints that operate on that website may respond with `404` or `409`. Poll this endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. `failed` means the setup stopped before finishing or has not reported progress for over an hour. Setups older than 24 hours are not listed. `type` is the website type the setup was started with (`wordpress`, `headless_empty`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`), or `null` for an empty website. */ "hosting_websites_list-setups": { params: { /** * Order ID */ order_id?: number; /** * Filter by hosting order subscription ID */ subscription_id?: string; /** * Filter by domain name (exact match) */ domain?: string; }; response: any; // Response structure will depend on the API }; /** * Starts a website setup on a Web or Cloud hosting order and returns the created setup right away; the website itself is provisioned asynchronously. Poll the list website setups endpoint (`hosting_websites_list-setups`) with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. Omit `type` for an empty website. `type: wordpress` installs WordPress in the website root with the admin user, email and password from `wordpress`, the domain as the site title, and `en_US` when `wordpress.language` is omitted. The headless types (`headless_empty`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory of the website root with generated credentials. `headless_empty` installs nothing: WordPress can be added later through `POST /api/hosting/v1/accounts/{username}/wordpress/installations` (`wordpress_installations_install`) with `type: headless`. Omit `domain` to set the website up on a generated temporary free subdomain. To know the free subdomain before the call, so a timed-out call can be looked up and retried on the same domain, generate one through `POST /api/hosting/v1/domains/free-subdomains` (`hosting_domains_generate-free-subdomain`) and send it as `domain`. It is accepted for 24 hours, only from the client that generated it. When the order has no hosting account yet, the setup creates one first, in the datacenter given by `datacenter_code` or the order's default datacenter when it is omitted. Returns 404 when the order does not exist or is not accessible to the authenticated client, and 409 with a `Retry-After` header while a setup for the same domain is still running. */ "hosting_websites_start-setup": { params: { /** * Hosting order ID. List orders to find available IDs. */ order_id: number; /** * Website type. Omit or `null` for an empty website. `wordpress` installs WordPress in the website root and requires `wordpress`. The headless types (`headless_empty`, `headless_wordpress`, `headless_ecommerce`, `headless_pocketbase`) create a headless website; `headless_wordpress` additionally installs WordPress into the `cms` directory with generated credentials. `headless_empty` installs nothing, so WordPress can be added later through `POST /api/hosting/v1/accounts/{username}/wordpress/installations` (`wordpress_installations_install`) with `type: headless`. */ type?: string; /** * Customer-owned domain, or a free subdomain you generated through `POST /api/hosting/v1/domains/free-subdomains` (`hosting_domains_generate-free-subdomain`) in the last 24 hours. Cannot start with "www." and can have at most one subdomain level, e.g. `blog.example.com`. Omit or `null` to set the website up on a generated temporary free subdomain. */ domain?: string; /** * Datacenter for the hosting account when the order does not have one yet. Omit to use the order's default datacenter. Ignored when the order already has a hosting account. List available datacenters to find valid codes. */ datacenter_code?: string; /** * WordPress install settings. Required when `type` is `wordpress`, not allowed otherwise. The site title is the domain. */ wordpress?: object; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of orders accessible to the authenticated client. Only Web and Cloud hosting orders are listed. Agency Plan orders are listed by `GET /api/agency-hosting/v1/orders`. This endpoint returns orders of your hosting accounts as well as orders of other client hosting accounts that have shared access with you. Use the available query parameters to filter results by order statuses or specific order IDs for more targeted results. */ "hosting_orders_list": { params: { /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Filter by order statuses */ statuses?: array; /** * Filter by specific order IDs */ order_ids?: array; }; response: any; // Response structure will depend on the API }; /** * Resets all PHP extensions of the website to their default state. Use it to recover from extension conflicts or restore the original configuration. */ "hosting_php_reset-extensions": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the full PHP configuration for the website: current version, available versions (supported and unsupported), enabled/disabled extensions, options with their current value, default, type and the plan limit (`max`), and conflicting extension groups. Use it to check the current PHP setup before updating the version, extensions or options. */ "hosting_php_get": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the full phpinfo page (HTML) for the website. Use it to debug PHP issues or inspect the complete PHP environment of the website. */ "hosting_php_info": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Enables or disables PHP extensions (modules) for the website. Use the Get PHP details endpoint to check the current extension states before changing them. */ "hosting_php_update-extensions": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * PHP extensions to enable. */ enable?: array; /** * PHP extensions to disable. */ disable?: array; }; response: any; // Response structure will depend on the API }; /** * Updates PHP options for the website (e.g. `memory_limit`, `max_execution_time`, `upload_max_filesize`). Only provide the options you want to change, inside the `options` object. Values above the account plan limit are silently capped to that limit, so the request can succeed with a smaller applied value. Call the Get PHP details endpoint afterwards to read the applied value. */ "hosting_php_update-options": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Map of PHP options to update, keyed by option name. Only include options you want to change. */ options: object; }; response: any; // Response structure will depend on the API }; /** * Changes the PHP version of the website. Use the Get PHP details endpoint to see the versions available for the website. */ "hosting_php_update-version": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * PHP version to switch the website to. */ version: string; }; response: any; // Response structure will depend on the API }; /** * Returns a paginated list of redirects configured for the selected website. */ "hosting_redirects_list-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Creates a redirect from a URL on the selected website to another URL or IP address. */ "hosting_redirects_create-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Source URL on the selected website */ from: string; /** * Destination URL or IP address */ to: string; }; response: any; // Response structure will depend on the API }; /** * Permanently deletes the redirect identified by its source URL. Pass the `from` value exactly as returned by the list redirects endpoint. */ "hosting_redirects_delete-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Source URL returned by the list redirects endpoint. */ from: string; }; response: any; // Response structure will depend on the API }; /** * Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled. Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website's certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first. */ "hosting_ssl_install": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error. `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate's validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null. */ "hosting_ssl_status": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted. */ "hosting_ssl_toggle-https-redirect": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Turn the HTTP to HTTPS redirect on (true) or off (false) for the website. */ is_enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe. Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`. */ "hosting_ssl_uninstall": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results. A website appears in this list before its server-side setup has finished, and `is_enabled` reflects suspension, not readiness. To know when a newly created website is ready for file, deploy or database operations, poll the list website setups endpoint instead. */ "hosting_websites_list": { params: { /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Filter by specific username */ username?: string; /** * Order ID */ order_id?: number; /** * Filter by enabled status */ is_enabled?: boolean; /** * Filter by domain name (case-insensitive substring match) */ domain?: string; /** * Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list. */ website_types?: array; }; response: any; // Response structure will depend on the API }; /** * Deprecated: use `POST /api/hosting/v1/orders/{order_id}/onboardings` (start website setup) instead. It takes the same `domain` and `datacenter_code`, can also install WordPress, and returns the created setup. Create a new website for the authenticated client. You must choose which hosting order to create this website on. Pass that order as `order_id` together with the domain name. List orders to see available IDs; the website is provisioned on that order's hosting plan. Only Web and Cloud hosting orders are accepted. To create a website on an Agency Plan order, use `POST /api/agency-hosting/v1/orders/{order_id}/websites/setups`. When the order has no hosting account yet, a new hosting account is set up first, in the datacenter given by `datacenter_code` or the order's default datacenter when it is omitted. Subsequent websites will be hosted on the same datacenter automatically. Website creation is asynchronous and takes up to a few minutes. Poll the list website setups endpoint with the `domain` filter every 10 to 15 seconds and wait for `status: completed` before uploading files, deploying or creating databases. While the setup is `running`, endpoints that operate on the website may respond with `404` or `409`. `is_enabled` on the websites list reflects suspension, not readiness. */ "hosting_websites_create": { params: { /** * Domain name for the website. Cannot start with "www." and can have at most one subdomain level, e.g. `blog.example.com`. */ domain: string; /** * Hosting order ID to create this website on. Choose the order whose hosting plan should host the new website. List orders to find available IDs. */ order_id: number; /** * Datacenter for the hosting account when the order does not have one yet. Omit to use the order's default datacenter. Ignored when the order already has a hosting account. Must be an available datacenter; list available datacenters to find valid codes. */ datacenter_code?: string; }; response: any; // Response structure will depend on the API }; /** * Deploy a static application from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website's directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`. */ "hosting_websites_deploy-static-site-archive": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Relative path to the archive file from website root directory */ archive_path: string; }; response: any; // Response structure will depend on the API }; /** * This endpoint permanently removes a website and all of its data. This action cannot be undone. Before calling it, make sure the user understands the consequences and explicitly confirms that they want to proceed. All website files, databases and related configuration will be removed. The hosting plan itself is kept, so a new website can be created on it afterwards. Supported websites: main and addon domain websites on web hosting plans, and Website Builder websites. Parked domains and subdomains cannot be deleted with this endpoint. The domain must be the exact website domain, not a preview domain or an alias. Returns 404 when the domain does not exist or does not belong to the authenticated client. Website removal is processed asynchronously and can take a few minutes to complete. The response returns before the removal finishes. */ "hosting_websites_delete": { params: { /** * Domain name */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Create an alias for the given mailbox. The alias address is formed from the given local part and the domain of the mailbox. Messages sent to the alias are delivered to the mailbox. */ "mail_aliases_create-alias": { params: { /** * Mailbox resource ID */ mailboxId: string; /** * Local part of the alias address (the part before the @). The domain is taken from the mailbox. Case-insensitive and stored lowercase; must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between. */ local_part: string; }; response: any; // Response structure will depend on the API }; /** * Delete an alias. Messages sent to the alias address are no longer delivered to the mailbox. */ "mail_aliases_delete-alias": { params: { /** * Alias resource ID */ aliasId: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of aliases across all mailboxes of a mail order. */ "mail_aliases_list": { params: { /** * Order resource ID */ orderId: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create an API token for the given mail order. The token grants access to the [Hostinger Email API](https://api.mail.hostinger.com/), where you can provision and manage the mailboxes it is scoped to. The plaintext token is returned only in this response, never again. A maximum of 10 tokens can exist per order. Use `scope.has_all_mailboxes` to cover all current and future mailboxes, or list specific mailboxes in `scope.mailbox_ids`. */ "mail_api-tokens_create": { params: { /** * Order resource ID */ orderId: string; /** * Human-readable label for this token */ name: string; /** * Mailbox scope this token can access */ scope: object; }; response: any; // Response structure will depend on the API }; /** * Revoke an API token. The token immediately loses access to the [Hostinger Email API](https://api.mail.hostinger.com/). This action cannot be undone. */ "mail_api-tokens_revoke": { params: { /** * API token ID (returned when the token was created) */ tokenId: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of [Hostinger Email API](https://api.mail.hostinger.com/) tokens across all your mail orders, optionally filtered by order. Plaintext tokens are never included; they are returned only when a token is created. */ "mail_api-tokens_list": { params: { /** * Filter tokens by order resource ID. Single value or comma-separated list. */ order_id?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create an automatic reply for the given mailbox. A mailbox can have only one autoreply. Omit `starts_at` to activate the autoreply immediately and omit `ends_at` to keep it active indefinitely. */ "mail_autoreplies_create": { params: { /** * Mailbox resource ID */ mailboxId: string; /** * Subject of the automatic reply */ subject: string; /** * Body of the automatic reply */ body: string; /** * Sender display name used for the reply */ display_name?: string; /** * When the autoreply becomes active. Defaults to now. */ starts_at?: string; /** * When the autoreply stops. Omit for an indefinite autoreply. */ ends_at?: string; }; response: any; // Response structure will depend on the API }; /** * Replace the autoreply with the given content and schedule. Omitted optional fields are cleared: omit `starts_at` to activate the autoreply immediately and omit `ends_at` to keep it active indefinitely. */ "mail_autoreplies_update": { params: { /** * Autoreply resource ID */ autoreplyId: string; /** * Subject of the automatic reply */ subject: string; /** * Body of the automatic reply */ body: string; /** * Sender display name used for the reply */ display_name?: string; /** * When the autoreply becomes active. Defaults to now. */ starts_at?: string; /** * When the autoreply stops. Omit for an indefinite autoreply. */ ends_at?: string; }; response: any; // Response structure will depend on the API }; /** * Delete the autoreply of a mailbox. The mailbox stops sending automatic replies immediately. */ "mail_autoreplies_delete": { params: { /** * Autoreply resource ID */ autoreplyId: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of autoreplies across all mailboxes of a mail order. */ "mail_autoreplies_list": { params: { /** * Order resource ID */ orderId: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a catch-all that routes all messages sent to unknown addresses of the domain to the given mailbox. The mailbox address receives a confirmation email and the catch-all becomes active only after it is confirmed. A domain can have only one catch-all. */ "mail_catchalls_create-catch-all": { params: { /** * Mailbox resource ID */ mailboxId: string; }; response: any; // Response structure will depend on the API }; /** * Delete a catch-all. Messages sent to unknown addresses of the domain are no longer routed to the mailbox. */ "mail_catchalls_delete-catch-all": { params: { /** * Catch-all resource ID */ catchallId: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of catch-alls across all mailboxes of a mail order. */ "mail_catchalls_list-catch-alls": { params: { /** * Order resource ID */ orderId: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Resend the confirmation email to the mailbox address of an unconfirmed catch-all. */ "mail_catchalls_resend-catch-all-confirmation": { params: { /** * Catch-all resource ID */ catchallId: string; }; response: any; // Response structure will depend on the API }; /** * Create a forwarder from the given mailbox to the destination address. The destination receives a confirmation email and forwarding becomes active only after it is confirmed. */ "mail_forwarders_create": { params: { /** * Mailbox resource ID */ mailboxId: string; /** * Email address the messages will be forwarded to */ destination: string; /** * Whether to keep a copy of forwarded messages in the mailbox. Defaults to false. */ is_keep_copy_enabled?: boolean; }; response: any; // Response structure will depend on the API }; /** * Delete a forwarder. The mailbox stops forwarding messages to the destination address immediately. */ "mail_forwarders_delete": { params: { /** * Forwarder resource ID */ forwarderId: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of forwarders across all mailboxes of a mail order. */ "mail_forwarders_list": { params: { /** * Order resource ID */ orderId: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Resend the confirmation email to the destination address of an unconfirmed forwarder. */ "mail_forwarders_resend-confirmation": { params: { /** * Forwarder resource ID */ forwarderId: string; }; response: any; // Response structure will depend on the API }; /** * Enable or disable keeping a copy of forwarded messages in the mailbox. */ "mail_forwarders_update-keep-copy-setting": { params: { /** * Forwarder resource ID */ forwarderId: string; /** * Whether to keep a copy of forwarded messages in the mailbox */ is_keep_copy_enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Retrieve paginated access logs for the domain attached to the given mail order. Supports filtering by account, date range, protocol, status, and deletion flag. Results are sorted by timestamp descending. */ "mail_logs_list-access": { params: { /** * Order resource ID */ orderId: string; /** * Filter log entries by a specific email account */ account?: string; /** * Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given. */ date?: string; /** * Date range start (RFC 3339) */ from_date?: string; /** * Date range end (RFC 3339) */ to_date?: string; /** * Filter log entries by status */ status?: string; /** * Filter access log entries by protocol */ protocol?: string; /** * Filter access log entries by whether the session had deletions */ has_deletions?: boolean; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve paginated account action logs (administrative and user actions) for the given mail order. Supports filtering by account, date range, and status. Results are sorted by timestamp descending. */ "mail_logs_list-action": { params: { /** * Order resource ID */ orderId: string; /** * Filter log entries by a specific email account */ account?: string; /** * Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given. */ date?: string; /** * Date range start (RFC 3339) */ from_date?: string; /** * Date range end (RFC 3339) */ to_date?: string; /** * Filter log entries by status */ status?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve paginated inbound (received mail) delivery logs for the domain attached to the given mail order. Supports filtering by account, date range, status, sender, and recipient. Results are sorted by timestamp descending. */ "mail_logs_list-inbound": { params: { /** * Order resource ID */ orderId: string; /** * Filter log entries by a specific email account */ account?: string; /** * Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given. */ date?: string; /** * Date range start (RFC 3339) */ from_date?: string; /** * Date range end (RFC 3339) */ to_date?: string; /** * Filter log entries by status */ status?: string; /** * Filter log entries by sender. Accepts a full email address or a domain. */ sender?: string; /** * Filter log entries by recipient. Accepts a full email address or a domain. */ recipient?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve paginated mailbox action logs (message and mailbox events) for a mailbox in the given mail order. The mailbox email must belong to the order's domain. Supports date range and event type filters. Results are sorted by timestamp descending. */ "mail_logs_list-mailbox-action": { params: { /** * Order resource ID */ orderId: string; /** * Mailbox email address. Must belong to the order's domain. */ email: string; /** * Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given. */ date?: string; /** * Date range start (RFC 3339) */ from_date?: string; /** * Date range end (RFC 3339) */ to_date?: string; /** * Filter mailbox action log entries by event type */ event?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve paginated outbound (sent mail) delivery logs for the domain attached to the given mail order. Supports filtering by account, date range, status, sender, and recipient. Results are sorted by timestamp descending. */ "mail_logs_list-outbound": { params: { /** * Order resource ID */ orderId: string; /** * Filter log entries by a specific email account */ account?: string; /** * Exact date filter (YYYY-MM-DD). Takes precedence over `from_date`/`to_date` when both are given. */ date?: string; /** * Date range start (RFC 3339) */ from_date?: string; /** * Date range end (RFC 3339) */ to_date?: string; /** * Filter log entries by status */ status?: string; /** * Filter log entries by sender. Accepts a full email address or a domain. */ sender?: string; /** * Filter log entries by recipient. Accepts a full email address or a domain. */ recipient?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of mailboxes belonging to a mail order. Use this endpoint to monitor mailboxes of your mail service, including their status, enabled protocols, attached resource counts, and periodically synced usage numbers (usage may lag behind live values). */ "mail_mailboxes_list": { params: { /** * Order resource ID */ orderId: string; /** * Filter mailboxes whose email address contains the given string */ search?: string; /** * Sort mailboxes by field. Prefix with `-` for descending order. */ sort?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a mailbox under the given mail order. The full email address is composed from the given local part and the domain of the order. */ "mail_mailboxes_create-mailbox": { params: { /** * Order resource ID */ orderId: string; /** * Local part of the mailbox address (the part before the @). The domain is taken from the order. Must start and end with a letter or digit; single dots, underscores and hyphens are allowed in between. */ local_part: string; /** * Mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character. */ password: string; }; response: any; // Response structure will depend on the API }; /** * Delete a mailbox. The mailbox is soft-deleted and stays restorable for a limited period before it is permanently removed. */ "mail_mailboxes_delete-mailbox": { params: { /** * Mailbox resource ID */ mailboxId: string; }; response: any; // Response structure will depend on the API }; /** * Change the password of a mailbox. */ "mail_mailboxes_change-mailbox-password": { params: { /** * Mailbox resource ID */ mailboxId: string; /** * New mailbox password. Minimum 8 characters with uppercase, lowercase, number and special character; must not be a commonly used password. */ password: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of mail orders associated with your account. Use this endpoint to monitor your mail services, including their status, plan, attached domain, and expiration details. */ "mail_orders_list": { params: { /** * Filter orders by domain name (exact match) */ domain?: string; /** * Filter orders by status */ status?: string; /** * Filter orders by trial state */ is_trial?: boolean; /** * Sort orders by field. Prefix with `-` for descending order. */ sort?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve the plan the given mail order was purchased with, including domain-level and mailbox-level quotas, limits, and protocol availability. */ "mail_orders_plan": { params: { /** * Order resource ID */ orderId: string; }; response: any; // Response structure will depend on the API }; /** * Create a webhook for the given mailbox. The generated secret is returned only in this response and is sent as a bearer token with every delivery. */ "mail_webhooks_create": { params: { /** * Mailbox resource ID */ mailboxId: string; /** * Human-readable name for this webhook */ name: string; /** * Optional description of the webhook's purpose */ description?: string; /** * Events that trigger this webhook */ events: array; /** * Initial status of the webhook */ status?: string; /** * Publicly reachable URL that receives the webhook POST requests */ url: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of webhook delivery logs for the given mail order, including delivery outcome, duration, and retry counts. Supports filtering by mailbox. */ "mail_webhooks_list-delivery-logs": { params: { /** * Order resource ID */ orderId: string; /** * Filter by the mailbox resource ID the webhooks are attached to */ mailbox_id?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve the details of a single webhook. The webhook secret is never included; it is returned only when a webhook is created or its secret is regenerated. */ "mail_webhooks_get": { params: { /** * Webhook ID (returned when the webhook was created) */ webhookId: string; }; response: any; // Response structure will depend on the API }; /** * Permanently delete a webhook. This action cannot be undone. After deletion the URL no longer receives event notifications. */ "mail_webhooks_delete": { params: { /** * Webhook ID (returned when the webhook was created) */ webhookId: string; }; response: any; // Response structure will depend on the API }; /** * Partially update a webhook. Only the fields included in the request body are changed; omitted fields retain their current values. Pass `"description": null` to clear the description. */ "mail_webhooks_update": { params: { /** * Webhook ID (returned when the webhook was created) */ webhookId: string; /** * New human-readable name for the webhook */ name?: string; /** * New description, or null to clear it */ description?: string; /** * Replaces the full list of subscribed events */ events?: array; /** * New status for the webhook */ status?: string; /** * New URL to deliver events to */ url?: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve a paginated list of webhooks belonging to the given mail order. Supports filtering by mailbox and status. The webhook secret is never included; it is returned only when a webhook is created or its secret is regenerated. */ "mail_webhooks_list": { params: { /** * Order resource ID */ orderId: string; /** * Filter by the mailbox resource ID the webhooks are attached to */ mailbox_id?: string; /** * Filter webhooks by status */ status?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Regenerate the secret of a webhook. The previous secret is immediately invalidated. The new secret is returned only in this response and is sent as a bearer token with every delivery. */ "mail_webhooks_regenerate-secret": { params: { /** * Webhook ID (returned when the webhook was created) */ webhookId: string; }; response: any; // Response structure will depend on the API }; /** * Send a test delivery to the webhook URL and return the result. Test requests are rate limited upstream. */ "mail_webhooks_test": { params: { /** * Webhook ID (returned when the webhook was created) */ webhookId: string; }; response: any; // Response structure will depend on the API }; /** * Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint. */ "reach_automations_get": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Automation uuid parameter */ automationUuid: string; }; response: any; // Response structure will depend on the API }; /** * Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead. */ "reach_automations_list": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`. */ status?: string; /** * Order automations by creation date. Newest first unless set to `asc`. */ sort_direction?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list. */ "reach_automations_list-steps": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Automation uuid parameter */ automationUuid: string; }; response: any; // Response structure will depend on the API }; /** * Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint. */ "reach_campaigns_get": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Campaign uuid parameter */ campaignUuid: string; }; response: any; // Response structure will depend on the API }; /** * Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead. */ "reach_campaigns_list": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived. */ status?: string; /** * Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations. */ type?: string; /** * Order campaigns by creation date. Newest first unless set to `asc`. */ sort_direction?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a campaign in a profile. The campaign is created as a draft, so nothing is sent and no contact is touched. It has no audience yet either - targeting and scheduling are not part of this request, the draft is finished and sent from the Reach interface. */ "reach_campaigns_create-draft": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * From name shown to the recipients. */ sender_name: string; /** * From address of the campaign. Its domain has to be verified on the profile before the campaign can be sent. */ sender_email: string; /** * Name the campaign is listed under. Not shown to the recipients. */ title?: string; /** * Subject line of the email. */ subject?: string; /** * Template to send, as returned by the template endpoints. Can be left out and attached later, but the campaign cannot be sent without one. */ template_uuid?: string; /** * Extra campaign fields. Any key outside the listed ones is rejected. */ metadata?: object; }; response: any; // Response structure will depend on the API }; /** * Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once. */ "reach_campaigns_performance": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Campaign uuid parameter */ campaignUuid: string; }; response: any; // Response structure will depend on the API }; /** * Delete a contact with the specified UUID. This endpoint permanently removes a contact from the email marketing system. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot delete contacts of any other profile. Use `DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}` instead. */ "reach_contacts_delete": { params: { /** * UUID of the contact to delete */ uuid: string; }; response: any; // Response structure will depend on the API }; /** * Delete a custom contact field. Every value contacts hold for the field is deleted with it, and for the choice types so are its options. The contacts themselves are not affected. */ "reach_contact-fields_delete": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Contact field uuid parameter */ fieldUuid: string; }; response: any; // Response structure will depend on the API }; /** * Rename a custom contact field and, for the choice types, replace its option set. Options carrying a uuid are kept and relabelled, options without one are created, and any existing option left out of the list is deleted along with the values contacts hold for it. The field type and slug cannot be changed. */ "reach_contact-fields_update": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Contact field uuid parameter */ fieldUuid: string; /** * label parameter */ label: string; /** * Replaces the option set when provided. Entries carrying a uuid are kept and relabelled, entries without one are created, and any existing option missing from the list is deleted along with the values contacts hold for it. */ options?: array; }; response: any; // Response structure will depend on the API }; /** * Get the custom contact fields defined in a profile. Custom fields let you store your own attributes on contacts. The returned uuids are what you pass to the contact update endpoint to set values, and choice fields also list the options available to pick from. */ "reach_contact-fields_list": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Define a new custom contact field in a profile. The `slug` is derived from the label and, like the field type, cannot be changed later. Use the returned uuid to set values on contacts. */ "reach_contact-fields_create": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Immutable once the field exists */ type: string; /** * label parameter */ label: string; /** * Required for single_choice and multi_choice, ignored for the scalar types. Labels must be unique regardless of casing. */ options?: array; }; response: any; // Response structure will depend on the API }; /** * Get a list of all contact groups. This endpoint returns a list of contact groups that can be used to organize contacts. */ "reach_contacts_list-groups": { params: { }; response: any; // Response structure will depend on the API }; /** * Get a list of contacts, optionally filtered by group and subscription status. This endpoint returns a paginated list of contacts with their basic information. You can filter contacts by group UUID and subscription status. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot list contacts of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/contacts` instead, which also replaces the group filter with a tag filter. */ "reach_contacts_list": { params: { /** * Filter contacts by group UUID */ group_uuid?: string; /** * Filter contacts by subscription status */ subscription_status?: string; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a new contact in the email marketing system. This endpoint allows you to create a new contact with basic information like name, email, and surname. If double opt-in is enabled, the contact will be created with a pending status and a confirmation email will be sent. */ "reach_contacts_create": { params: { /** * email parameter */ email: string; /** * name parameter */ name?: string; /** * surname parameter */ surname?: string; /** * Phone number in E.164 format (leading "+" then 7-15 digits) */ phone?: string; /** * note parameter */ note?: string; /** * Existing tags to attach to the created contact */ tag_uuids?: array; }; response: any; // Response structure will depend on the API }; /** * Get the full details of a single contact. Alongside the contact's own attributes this returns the tags assigned to it and the values it holds for the profile's custom contact fields. */ "reach_contacts_get": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Contact uuid parameter */ contactUuid: string; }; response: any; // Response structure will depend on the API }; /** * Permanently delete a contact from a profile. The contact is removed together with its custom field values and tag assignments. */ "reach_contacts_delete-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Contact uuid parameter */ contactUuid: string; }; response: any; // Response structure will depend on the API }; /** * Update a contact's attributes and custom field values. Only the properties present in the request body are changed, so a partial body is enough to change a single attribute. Sending a property as `null` clears it. The response carries the contact's core attributes. Read back its tags, custom field values, source and note with `GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}`. */ "reach_contacts_update": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Contact uuid parameter */ contactUuid: string; /** * email parameter */ email?: string; /** * name parameter */ name?: string; /** * surname parameter */ surname?: string; /** * Phone number in E.164 format (leading "+" then 7-15 digits) */ phone?: string; /** * subscription_status parameter */ subscription_status?: string; /** * note parameter */ note?: string; /** * Set custom field values. Omit to leave untouched, send an empty array to clear them all. */ fields?: array; }; response: any; // Response structure will depend on the API }; /** * Create many contacts in a profile in a single call. The contacts are imported in the background, so a success response means the import was accepted rather than finished. Contacts whose email already exists in the profile are left as they are. If double opt-in is enabled, new contacts start off pending and are sent a confirmation email. */ "reach_contacts_create-in-bulk": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * contacts parameter */ contacts: array; /** * Existing tags to attach to every created contact */ tag_uuids?: array; /** * Note applied to every created contact */ note?: string; }; response: any; // Response structure will depend on the API }; /** * Get a paginated list of contacts belonging to a profile. Contacts can be filtered by subscription status, by tag, and by an email search term. The `meta.total` field of the response is the number of contacts matching the filters, so calling this endpoint without filters gives the profile's total contact count. */ "reach_contacts_list-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Filter contacts by subscription status */ subscription_status?: string; /** * Filter contacts by tag UUID */ tag_uuid?: string; /** * Search contacts by email */ search?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a new contact in the email marketing system. This endpoint allows you to create a new contact with basic information like name, email, and surname. If double opt-in is enabled, the contact will be created with a pending status and a confirmation email will be sent. */ "reach_contacts_create-bulk": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * email parameter */ email: string; /** * name parameter */ name?: string; /** * surname parameter */ surname?: string; /** * Phone number in E.164 format (leading "+" then 7-15 digits) */ phone?: string; /** * note parameter */ note?: string; /** * Existing tags to attach to the created contact */ tag_uuids?: array; }; response: any; // Response structure will depend on the API }; /** * Get a list of all contact segments. This endpoint returns a list of contact segments that can be used to organize contacts. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot list the segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead. */ "reach_segments_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Create a new contact segment. This endpoint allows creating a new contact segment that can be used to organize contacts. The segment can be configured with specific criteria like email, name, subscription status, etc. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot create segments in any other profile. Use `POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead. */ "reach_segments_create": { params: { /** * name parameter */ name: string; /** * conditions parameter */ conditions: array; /** * logic parameter */ logic: string; }; response: any; // Response structure will depend on the API }; /** * Count the contacts currently matching a segment without listing them. Cheaper than paging through the segment contacts endpoint when only the size is needed. */ "reach_segments_count-profile-contacts": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Segment uuid parameter */ segmentUuid: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve contacts associated with a specific segment for a given profile. This endpoint allows you to fetch and filter contacts that belong to a particular segment, identified by its UUID, scoped to a specific profile. */ "reach_segments_list-profile-contacts": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Segment uuid parameter */ segmentUuid: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Get a single segment of a profile, including the conditions that define it. To retrieve the contacts currently matching those conditions, use the segment contacts endpoint instead. */ "reach_segments_profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Segment uuid parameter */ segmentUuid: string; }; response: any; // Response structure will depend on the API }; /** * Rename a segment and/or replace the conditions that define it. `name` is always required. Omit `conditions` to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately. */ "reach_segments_update-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Segment uuid parameter */ segmentUuid: string; /** * name parameter */ name: string; /** * Replaces the existing conditions entirely. Omit to keep the current ones. */ conditions?: array; /** * How to combine multiple conditions. Required when conditions are given. */ logic?: string; }; response: any; // Response structure will depend on the API }; /** * Delete a segment. Only the segment definition is removed. The contacts that matched it are left untouched. */ "reach_segments_delete-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Segment uuid parameter */ segmentUuid: string; }; response: any; // Response structure will depend on the API }; /** * List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values. The list is profile specific: it includes the profile's custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations. */ "reach_segments_list-filter-attributes": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Preview the contacts matching a set of conditions without saving a segment. The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified. Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations. */ "reach_segments_preview-contacts-matching-conditions": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Conditions a contact must satisfy to appear in the preview */ conditions: array; /** * How to combine multiple conditions */ logic: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Narrow the preview to contacts whose email matches */ search?: string; /** * sort_by parameter */ sort_by?: string; /** * sort_direction parameter */ sort_direction?: string; }; response: any; // Response structure will depend on the API }; /** * Get a paginated list of the segments defined in a profile. Each entry carries the number of contacts currently matching it, which is recalculated on read rather than stored. Use `count_type` to count either every matching contact or only the subscribed ones. */ "reach_segments_list-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Which matching contacts to count for each segment */ count_type?: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a segment in a profile. A segment is a saved set of conditions rather than a fixed list, so its membership changes as contacts change. Creating one does not modify any contact. */ "reach_segments_create-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * name parameter */ name: string; /** * Conditions a contact must satisfy to fall into the segment */ conditions: array; /** * How to combine multiple conditions */ logic: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve contacts associated with a specific segment. This endpoint allows you to fetch and filter contacts that belong to a particular segment, identified by its UUID. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot read segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts` instead. */ "reach_segments_list-contacts": { params: { /** * Segment uuid parameter */ segmentUuid: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; }; response: any; // Response structure will depend on the API }; /** * Get details of a specific segment. This endpoint retrieves information about a single segment identified by UUID. Segments are used to organize and group contacts based on specific criteria. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client's default profile and cannot read segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}` instead. */ "reach_segments_get": { params: { /** * Segment uuid parameter */ segmentUuid: string; }; response: any; // Response structure will depend on the API }; /** * Assign a tag to a single contact. Unlike the bulk endpoint this is applied immediately rather than queued. Assigning a tag the contact already carries succeeds without duplicating it. */ "reach_tags_assign-contact-to": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; /** * Contact uuid parameter */ contactUuid: string; }; response: any; // Response structure will depend on the API }; /** * Remove a tag from a single contact. Unlike the bulk endpoint this is applied immediately rather than queued. Neither the tag nor the contact is deleted. */ "reach_tags_remove-contact-from": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; /** * Contact uuid parameter */ contactUuid: string; }; response: any; // Response structure will depend on the API }; /** * Assign a tag to many contacts at once. Pass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact in the profile. The work is queued, so a success response means it was accepted rather than finished. Contacts that already carry the tag are left alone. */ "reach_tags_assign-contacts-to": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; /** * Contacts to apply the change to. Required unless all_contacts is true. */ contact_uuids?: array; /** * Apply to every contact in the profile */ all_contacts?: boolean; }; response: any; // Response structure will depend on the API }; /** * Remove a tag from many contacts at once. Pass `contact_uuids` to target specific contacts, or `all_contacts` to target every contact in the profile. The work is queued, so a success response means it was accepted rather than finished. The tag itself and the contacts are not deleted. */ "reach_tags_remove-contacts-from": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; }; response: any; // Response structure will depend on the API }; /** * Delete a tag and remove it from every contact carrying it. The contacts themselves are not deleted. This is idempotent: deleting a tag that does not exist in the profile still succeeds. */ "reach_tags_delete": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; }; response: any; // Response structure will depend on the API }; /** * Rename a tag. The contacts assigned to the tag are unaffected. Names are unique within a profile, so renaming a tag to a name that is already taken is rejected. */ "reach_tags_rename": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Tag uuid parameter */ tagUuid: string; /** * New tag name */ value: string; }; response: any; // Response structure will depend on the API }; /** * Get all tags defined in a profile. Tags are the way contacts are grouped in Reach, and can be used to filter the contact list or to build segments. */ "reach_tags_list-profile": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Create tags in a profile. Names that already exist in the profile are not duplicated: the existing tag is returned instead, so the call is safe to repeat. Every tag in the request is returned, whether it was created now or already existed. */ "reach_tags_create-or-find": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * names parameter */ names: array; }; response: any; // Response structure will depend on the API }; /** * Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid. */ "reach_forms_get": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; }; response: any; // Response structure will depend on the API }; /** * Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion. */ "reach_forms_delete": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; }; response: any; // Response structure will depend on the API }; /** * Rename a form and/or change its status. Setting a `draft` or `paused` form to `active` takes it live: its latest saved design is published and visitors can submit it. `paused` and `draft` stop the form from accepting submissions. A form is not reachable by visitors until it is taken live. Design changes saved while the form is already `active` stay unpublished until the form is paused and set to `active` again. Renaming does not rename the automatic `form:{name}` tag. */ "reach_forms_update": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; /** * Form name. Letters, digits, spaces and - . ' _ only. */ name?: string; /** * `active` takes the form live, `paused` and `draft` stop it accepting submissions. */ status?: string; }; response: any; // Response structure will depend on the API }; /** * Copy a form into a new draft form with the same name and design. The copy shares the source's automatic `form:{name}` tag; other submitter tags are not copied. The copy is not live until its status is set to `active`. */ "reach_forms_duplicate": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; }; response: any; // Response structure will depend on the API }; /** * Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures. */ "reach_forms_list": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Page number */ page?: number; /** * Number of items per page */ per_page?: number; /** * Return only forms with this status. */ status?: string; }; response: any; // Response structure will depend on the API }; /** * Create an empty draft form. Reach also adds an automatic `form:{name}` tag that every submitter receives. A draft has no design and is not reachable by visitors: save a design with the update form template operation, then take the form live by setting its status to `active`. Creating a form does not consume AI credits. */ "reach_forms_create": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form name. Letters, digits, spaces and - . ' _ only. */ name: string; }; response: any; // Response structure will depend on the API }; /** * Add tags to a form so that every contact who submits it from now on receives them. A tag the form already has is skipped; an unknown tag is rejected. Contacts who submitted earlier are not tagged. */ "reach_forms_add-submitter-tags": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; /** * tag_uuids parameter */ tag_uuids: array; }; response: any; // Response structure will depend on the API }; /** * Stop a form from applying a tag to its future submitters. Succeeds also when the form did not have the tag. Contacts who already received the tag keep it, and the tag itself is not deleted. The automatic `form:{name}` tag cannot be removed and is rejected with a conflict. */ "reach_forms_remove-submitter-tag": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; }; response: any; // Response structure will depend on the API }; /** * Save `content` as the latest design of a form and return the stored version. The HTML is sanitized and, unless the plan allows removing it, the Reach signature is added. Visitors submit the form with an `email` field (required) and optional `name`, `surname` and `phone`. After sanitizing, the design must contain a form container (`data-reach-form`), an email input (`data-reach-field="email"`) and a submit button (`data-reach-submit`); otherwise the request fails with `422` and `errors.content` lists `missing_form_container`, `missing_email_field` and/or `missing_submit_button`. A `draft` or `paused` form stays unreachable until its status is set to `active`, which publishes this design. On a form that is already `active` the saved design is not public until the form is paused and set to `active` again. Saving a design does not consume AI credits. */ "reach_forms_update-template": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * Form uuid parameter */ formUuid: string; /** * HTML of the form design. After sanitizing it must still contain a form container (`data-reach-form`), an email input (`data-reach-field="email"`) and a submit button (`data-reach-submit`). */ content: string; }; response: any; // Response structure will depend on the API }; /** * Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint. */ "reach_profiles_connected-sending-domain": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`. */ "reach_profiles_connect-sending-domain": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * domain parameter */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling. */ "reach_profiles_delete-sending-domain": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve the DNS configuration status for a profile's domain. This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the actual records found and the suggested records required for correct email delivery. */ "reach_profiles_domain-dns-status": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation. */ "reach_profiles_list-plan-feature-access": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept. */ "reach_profiles_remaining-plan-limits": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * This endpoint returns all profiles available to the client, including their basic information. */ "reach_profiles_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Get the profile's saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that. */ "reach_profiles_settings": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Change the profile's default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile's connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change. */ "reach_profiles_update-settings": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * brand_name parameter */ brand_name?: string; /** * website_url parameter */ website_url?: string; /** * business_address parameter */ business_address?: string; /** * privacy_policy_url parameter */ privacy_policy_url?: string; /** * accent_color parameter */ accent_color?: string; /** * button_color parameter */ button_color?: string; /** * background_color parameter */ background_color?: string; /** * text_color parameter */ text_color?: string; /** * links_color parameter */ links_color?: string; /** * Button text colour. */ button_text?: string; /** * button_corners parameter */ button_corners?: number; /** * font_family parameter */ font_family?: string; /** * heading_font_family parameter */ heading_font_family?: string; /** * Public image URL. Logo uploads are not supported. */ logo_url?: string; /** * social_links parameter */ social_links?: array; /** * Social profile links keyed by platform. */ socials?: object; /** * about parameter */ about?: string; /** * keywords parameter */ keywords?: array; /** * topics parameter */ topics?: array; /** * selling_points parameter */ selling_points?: array; /** * Default sender name. Letters, numbers and spaces only. */ sender_name?: string; /** * Part of the default sender address before the `@`, for example `hello`. Never send a full address: Reach adds the profile's connected sending domain itself. */ sender_email?: string; }; response: any; // Response structure will depend on the API }; /** * Get a list of the email templates in a profile, most recently updated first. Templates are the reusable email bodies a campaign is built from. The list is not paginated and only the metadata is returned - the template content itself is not exposed. Use the `uuid` of a template as the `template_uuid` when creating a campaign. */ "reach_templates_list-email": { params: { /** * Profile uuid parameter */ profileUuid: string; }; response: any; // Response structure will depend on the API }; /** * Create an email template in a profile. The template holds the HTML body a campaign reuses, so it can be created before any campaign exists. Only the template metadata comes back - keep the returned `uuid` to reference it as the `template_uuid` of a campaign. */ "reach_templates_create-email": { params: { /** * Profile uuid parameter */ profileUuid: string; /** * The email body as HTML. It is sanitised before it is stored, so the saved template can differ from what was sent - inline any styles the email clients need and keep the markup self-contained. */ template_content: string; /** * Name the template is listed under. Not shown to the recipients. */ title?: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve all available data centers. Use this endpoint to view location options before deploying VPS instances. */ "vps_data-centers_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieves a list of all containers belonging to a specific Docker Compose project on the virtual machine. This endpoint returns detailed information about each container including their current status, port mappings, and runtime configuration. Use this to monitor the health and state of all services within your Docker Compose project. */ "vps_docker_containers": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Retrieves the complete project information including the docker-compose.yml file contents, project metadata, and current deployment status. This endpoint provides the full configuration and state details of a specific Docker Compose project. Use this to inspect project settings, review the compose file, or check the overall project health. */ "vps_docker_get": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Completely removes a Docker Compose project from the virtual machine, stopping all containers and cleaning up associated resources including networks, volumes, and images. This operation is irreversible and will delete all project data. Use this when you want to permanently remove a project and free up system resources. */ "vps_docker_delete": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Retrieves a list of all Docker Compose projects currently deployed on the virtual machine. This endpoint returns basic information about each project including name, status, file path and list of containers with details about their names, image, status, health and ports. Container stats are omitted in this endpoint. If you need to get detailed information about container with stats included, use the `Get project containers` endpoint. Use this to get an overview of all Docker projects on your VPS instance. */ "vps_docker_list": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Deploy new project from docker-compose.yaml contents or download contents from URL. URL can be Github repository url in format https://github.com/[user]/[repo] and it will be automatically resolved to docker-compose.yaml file in master branch. Any other URL provided must return docker-compose.yaml file contents. If project with the same name already exists, existing project will be replaced. */ "vps_docker_create": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ project_name: string; /** * URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file */ content: string; /** * Project environment variables */ environment?: string; }; response: any; // Response structure will depend on the API }; /** * Retrieves aggregated log entries from all services within a Docker Compose project. This endpoint returns recent log output from each container, organized by service name with timestamps. The response contains the last 300 log entries across all services. Use this for debugging, monitoring application behavior, and troubleshooting issues across your entire project stack. */ "vps_docker_logs": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Restarts all services in a Docker Compose project by stopping and starting containers in the correct dependency order. This operation preserves data volumes and network configurations while refreshing the running containers. Use this to apply configuration changes or recover from service failures. */ "vps_docker_restart": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Starts all services in a Docker Compose project that are currently stopped. This operation brings up containers in the correct dependency order as defined in the compose file. Use this to resume a project that was previously stopped or to start services after a system reboot. */ "vps_docker_start": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Stops all running services in a Docker Compose project while preserving container configurations and data volumes. This operation gracefully shuts down containers in reverse dependency order. Use this to temporarily halt a project without removing data or configurations. */ "vps_docker_stop": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Updates a Docker Compose project by pulling the latest image versions and recreating containers with new configurations. This operation preserves data volumes while applying changes from the compose file. Use this to deploy application updates, apply configuration changes, or refresh container images to their latest versions. */ "vps_docker_update": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ projectName: string; }; response: any; // Response structure will depend on the API }; /** * Activate a firewall for a specified virtual machine. Only one firewall can be active for a virtual machine at a time. Use this endpoint to apply firewall rules to VPS instances. */ "vps_firewall_activate": { params: { /** * Firewall ID */ firewallId: number; /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Deactivate a firewall for a specified virtual machine. Use this endpoint to remove firewall protection from VPS instances. */ "vps_firewall_deactivate": { params: { /** * Firewall ID */ firewallId: number; /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve firewall by its ID and rules associated with it. Use this endpoint to view specific firewall configuration and rules. */ "vps_firewall_get": { params: { /** * Firewall ID */ firewallId: number; }; response: any; // Response structure will depend on the API }; /** * Delete a specified firewall. Any virtual machine that has this firewall activated will automatically have it deactivated. Use this endpoint to remove unused firewall configurations. */ "vps_firewall_delete": { params: { /** * Firewall ID */ firewallId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve all available firewalls. Use this endpoint to view existing firewall configurations. */ "vps_firewall_list": { params: { /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Create a new firewall. Use this endpoint to set up new firewall configurations for VPS security. */ "vps_firewall_create": { params: { /** * name parameter */ name: string; }; response: any; // Response structure will depend on the API }; /** * Update a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to modify existing firewall rules. */ "vps_firewall_update-rule": { params: { /** * Firewall ID */ firewallId: number; /** * Firewall Rule ID */ ruleId: number; /** * protocol parameter */ protocol: string; /** * Port or port range, ex: 1024:2048 */ port: string; /** * source parameter */ source: string; /** * IP range, CIDR, single IP or `any` */ source_detail: string; }; response: any; // Response structure will depend on the API }; /** * Delete a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to remove specific firewall rules. */ "vps_firewall_delete-rule": { params: { /** * Firewall ID */ firewallId: number; /** * Firewall Rule ID */ ruleId: number; }; response: any; // Response structure will depend on the API }; /** * Replaces all firewall rules within a specified firewall group with the provided set of rules in a single atomic operation, instead of creating or deleting rules one by one. Any virtual machine using this firewall group will need to be synchronized after replacing rules; pass the "sync" parameter to trigger synchronization immediately. */ "vps_firewall_replace-all-rules-in-group": { params: { /** * Firewall ID */ firewallId: number; /** * The complete set of firewall rules that atomically replaces all existing rules in the group */ rules: array; /** * Synchronize the firewall group to all its virtual machines after replacing the rules */ sync?: boolean; }; response: any; // Response structure will depend on the API }; /** * Create new firewall rule for a specified firewall. By default, the firewall drops all incoming traffic, which means you must add accept rules for all ports you want to use. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to add new security rules to firewalls. */ "vps_firewall_create-rule": { params: { /** * Firewall ID */ firewallId: number; /** * protocol parameter */ protocol: string; /** * Port or port range, ex: 1024:2048 */ port: string; /** * source parameter */ source: string; /** * IP range, CIDR, single IP or `any` */ source_detail: string; }; response: any; // Response structure will depend on the API }; /** * Sync a firewall's rules to every virtual machine it's assigned to. Firewall can lose sync with a virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall. */ "vps_firewall_sync-to-all-assigned-v-ms": { params: { /** * Firewall ID */ firewallId: number; }; response: any; // Response structure will depend on the API }; /** * Deprecated: use `POST /api/vps/v1/firewall/{firewallId}/sync` instead, which syncs the firewall to all virtual machines assigned to it. Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances. */ "vps_firewall_sync": { params: { /** * Firewall ID */ firewallId: number; /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve post-install script by its ID. Use this endpoint to view specific automation script details. */ "vps_post-install-scripts_get": { params: { /** * Post-install script ID */ postInstallScriptId: number; }; response: any; // Response structure will depend on the API }; /** * Update a specific post-install script. Use this endpoint to modify existing automation scripts. */ "vps_post-install-scripts_update": { params: { /** * Post-install script ID */ postInstallScriptId: number; /** * Name of the script */ name: string; /** * Content of the script */ content: string; }; response: any; // Response structure will depend on the API }; /** * Delete a post-install script from your account. Use this endpoint to remove unused automation scripts. */ "vps_post-install-scripts_delete": { params: { /** * Post-install script ID */ postInstallScriptId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve post-install scripts associated with your account. Use this endpoint to view available automation scripts for VPS deployment. */ "vps_post-install-scripts_list": { params: { /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Add a new post-install script to your account, which can then be used after virtual machine installation. The script contents will be saved to the file `/post_install` with executable attribute set and will be executed once virtual machine is installed. The output of the script will be redirected to `/post_install.log`. Maximum script size is 48KB. Use this endpoint to create automation scripts for VPS setup tasks. */ "vps_post-install-scripts_create": { params: { /** * Name of the script */ name: string; /** * Content of the script */ content: string; }; response: any; // Response structure will depend on the API }; /** * Deprecated: use `POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys` instead. Attach existing public keys from your account to a specified virtual machine. Multiple keys can be attached to a single virtual machine. Use this endpoint to enable SSH key authentication for VPS instances. */ "vps_public-keys_attach": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Public Key IDs to attach */ ids: array; }; response: any; // Response structure will depend on the API }; /** * Deprecated: account-level public keys have no direct replacement. Root SSH keys are now managed per virtual machine via `DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys`. Delete a public key from your account. **Deleting public key from account does not remove it from virtual machine** Use this endpoint to remove unused SSH keys from account. */ "vps_public-keys_delete": { params: { /** * Public Key ID */ publicKeyId: number; }; response: any; // Response structure will depend on the API }; /** * Deprecated: account-level public keys have no direct replacement. Root SSH keys are now managed per virtual machine via `GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys`. Retrieve public keys associated with your account. Use this endpoint to view available SSH keys for VPS authentication. */ "vps_public-keys_list": { params: { /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Deprecated: account-level public keys have no direct replacement. Root SSH keys are now managed per virtual machine via `POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys`. Add a new public key to your account. Use this endpoint to register SSH keys for VPS authentication. */ "vps_public-keys_create": { params: { /** * name parameter */ name: string; /** * key parameter */ key: string; }; response: any; // Response structure will depend on the API }; /** * Retrieve SSH public keys currently configured on a specified virtual machine. Only keys of the `root` user are listed. Use this endpoint to view SSH keys that can be used for authentication on VPS instances. */ "vps_ssh-keys_list-virtual-machine": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Add one or more SSH public keys to a specified virtual machine. Keys are added to the `root` user and can be used for passwordless SSH authentication. Returns the complete list of SSH keys currently configured on the virtual machine. Use this endpoint to enable SSH key authentication for VPS instances. */ "vps_ssh-keys_add-virtual-machine": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * SSH public keys in OpenSSH format to add */ keys: array; }; response: any; // Response structure will depend on the API }; /** * Remove one or more SSH public keys from a specified virtual machine. Removed keys can no longer be used to authenticate via SSH as the `root` user. Returns the remaining list of SSH keys configured on the virtual machine. Use this endpoint to revoke SSH key access to VPS instances. */ "vps_ssh-keys_remove-virtual-machine": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve detailed information about a specific OS template for virtual machines. Use this endpoint to view specific template specifications before deployment. */ "vps_templates_get": { params: { /** * Template ID */ templateId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve available OS templates for virtual machines. Use this endpoint to view operating system options before creating or recreating VPS instances. */ "vps_templates_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Retrieve detailed information about a specific action performed on a specified virtual machine. Use this endpoint to monitor specific VPS operation status and details. */ "vps_actions_get": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Action ID */ actionId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve actions performed on a specified virtual machine. Actions are operations or events that have been executed on the virtual machine, such as starting, stopping, or modifying the machine. This endpoint allows you to view the history of these actions, providing details about each action, such as the action name, timestamp, and status. Use this endpoint to view VPS operation history and troubleshoot issues. */ "vps_actions_list": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Deprecated: use `GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys` instead. Retrieve public keys attached to a specified virtual machine. Use this endpoint to view SSH keys configured for specific VPS instances. */ "vps_virtual-machines_attached-public-keys": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve backups for a specified virtual machine. Use this endpoint to view available backup points for VPS data recovery. */ "vps_backups_list": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Page number */ page?: number; }; response: any; // Response structure will depend on the API }; /** * Restore a backup for a specified virtual machine. The system will then initiate the restore process, which may take some time depending on the size of the backup. **All data on the virtual machine will be overwritten with the data from the backup.** Use this endpoint to recover VPS data from backup points. */ "vps_backups_restore": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Backup ID */ backupId: number; }; response: any; // Response structure will depend on the API }; /** * Set hostname for a specified virtual machine. Changing hostname does not update PTR record automatically. If you want your virtual machine to be reachable by a hostname, you need to point your domain A/AAAA records to virtual machine IP as well. Use this endpoint to configure custom hostnames for VPS instances. */ "vps_virtual-machines_set-hostname": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * hostname parameter */ hostname: string; }; response: any; // Response structure will depend on the API }; /** * Reset hostname and PTR record of a specified virtual machine to default value. Use this endpoint to restore default hostname configuration for VPS instances. */ "vps_virtual-machines_reset-hostname": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve detailed information about a specified virtual machine. Use this endpoint to view comprehensive VPS configuration and status. */ "vps_virtual-machines_get": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve all available virtual machines. Use this endpoint to view available VPS instances. */ "vps_virtual-machines_list": { params: { }; response: any; // Response structure will depend on the API }; /** * Purchase and setup a new virtual machine. If virtual machine setup fails for any reason, login to [hPanel](https://hpanel.hostinger.com/) and complete the setup manually. If no payment method is provided, your default payment method will be used automatically. If the response is `202 Accepted`, the payment is still being processed and the virtual machine was not set up. Login to [hPanel](https://hpanel.hostinger.com/) and complete the setup manually. Use this endpoint to create new VPS instances. */ "vps_virtual-machines_purchase": { params: { /** * Catalog price item ID */ item_id: string; /** * Payment method ID, default will be used if not provided */ payment_method_id?: number; /** * setup parameter */ setup: string; /** * Discount coupon codes */ coupons?: array; }; response: any; // Response structure will depend on the API }; /** * Retrieve scan metrics for the [Monarx](https://www.monarx.com/) malware scanner installed on a specified virtual machine. The scan metrics provide detailed information about malware scans performed by Monarx, including number of scans, detected threats, and other relevant statistics. This information is useful for monitoring security status of the virtual machine and assessing effectiveness of the malware scanner. Use this endpoint to monitor VPS security scan results and threat detection. */ "vps_monarx_scan-metrics": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Install the Monarx malware scanner on a specified virtual machine. [Monarx](https://www.monarx.com/) is a security tool designed to detect and prevent malware infections on virtual machines. By installing Monarx, users can enhance the security of their virtual machines, ensuring that they are protected against malicious software. Use this endpoint to enable malware protection on VPS instances. */ "vps_monarx_install": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Uninstall the Monarx malware scanner on a specified virtual machine. If Monarx is not installed, the request will still be processed without any effect. Use this endpoint to remove malware scanner from VPS instances. */ "vps_monarx_uninstall": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Retrieve historical metrics for a specified virtual machine. It includes the following metrics: - CPU usage - Memory usage - Disk usage - Network usage - Uptime Use this endpoint to monitor VPS performance and resource utilization over time. */ "vps_virtual-machines_metrics": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * date_from parameter */ date_from: string; /** * date_to parameter */ date_to: string; }; response: any; // Response structure will depend on the API }; /** * Set nameservers for a specified virtual machine. Be aware, that improper nameserver configuration can lead to the virtual machine being unable to resolve domain names. Use this endpoint to configure custom DNS resolvers for VPS instances. */ "vps_virtual-machines_set-nameservers": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * ns1 parameter */ ns1: string; /** * ns2 parameter */ ns2?: string; /** * ns3 parameter */ ns3?: string; }; response: any; // Response structure will depend on the API }; /** * Create or update a PTR (Pointer) record for a specified virtual machine. Use this endpoint to configure reverse DNS lookup for VPS IP addresses. */ "vps_ptr_create": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * IP Address ID */ ipAddressId: number; /** * Pointer record domain */ domain: string; }; response: any; // Response structure will depend on the API }; /** * Delete a PTR (Pointer) record for a specified virtual machine. Once deleted, reverse DNS lookups to the virtual machine's IP address will no longer return the previously configured hostname. Use this endpoint to remove reverse DNS configuration from VPS instances. */ "vps_ptr_delete": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * IP Address ID */ ipAddressId: number; }; response: any; // Response structure will depend on the API }; /** * Set panel password for a specified virtual machine. If virtual machine does not use panel OS, the request will still be processed without any effect. Requirements for password are same as in the [recreate virtual machine endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate). Use this endpoint to configure control panel access credentials for VPS instances. */ "vps_virtual-machines_set-panel-password": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Panel password for the virtual machine */ password: string; }; response: any; // Response structure will depend on the API }; /** * Initiate recovery mode for a specified virtual machine. Recovery mode is a special state that allows users to perform system rescue operations, such as repairing file systems, recovering data, or troubleshooting issues that prevent the virtual machine from booting normally. Virtual machine will boot recovery disk image and original disk image will be mounted in `/mnt` directory. Use this endpoint to enable system rescue operations on VPS instances. */ "vps_recovery_start": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Temporary root password for recovery mode */ root_password: string; }; response: any; // Response structure will depend on the API }; /** * Stop recovery mode for a specified virtual machine. If virtual machine is not in recovery mode, this operation will fail. Use this endpoint to exit system rescue mode and return VPS to normal operation. */ "vps_recovery_stop": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Recreate a virtual machine from scratch. The recreation process involves reinstalling the operating system and resetting the virtual machine to its initial state. Snapshots, if there are any, will be deleted. ## Password Requirements Password will be checked against leaked password databases. Requirements for the password are: - At least 12 characters long - At least one uppercase letter - At least one lowercase letter - At least one number - Is not leaked publicly **This operation is irreversible and will result in the loss of all data stored on the virtual machine!** Use this endpoint to completely rebuild VPS instances with fresh OS installation. */ "vps_virtual-machines_recreate": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Template ID */ template_id: number; /** * Root password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response. */ password?: string; /** * Panel password for the panel-based OS template. If not provided, random password will be generated. If OS does not support panel_password this field will be ignored. Password will not be shown in the response. */ panel_password?: string; /** * Post-install script to execute after virtual machine was recreated */ post_install_script_id?: number; }; response: any; // Response structure will depend on the API }; /** * Restart a specified virtual machine by fully stopping and starting it. If the virtual machine was stopped, it will be started. Use this endpoint to reboot VPS instances. */ "vps_virtual-machines_restart": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Set root password for a specified virtual machine. Requirements for password are same as in the [recreate virtual machine endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMachineId}/recreate). Use this endpoint to update administrator credentials for VPS instances. */ "vps_virtual-machines_set-root-password": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Root password for the virtual machine */ password: string; }; response: any; // Response structure will depend on the API }; /** * Setup newly purchased virtual machine with `initial` state. Use this endpoint to configure and initialize purchased VPS instances. */ "vps_virtual-machines_setup": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Template ID */ template_id: number; /** * Data center ID */ data_center_id: number; /** * Post-install script ID */ post_install_script_id?: number; /** * Password for the virtual machine. If not provided, random password will be generated. Password will not be shown in the response. */ password?: string; /** * Override default hostname of the virtual machine */ hostname?: string; /** * Install Monarx malware scanner (if supported) */ install_monarx?: boolean; /** * Enable weekly backup schedule */ enable_backups?: boolean; /** * Name server 1 */ ns1?: string; /** * Name server 2 */ ns2?: string; /** * Use SSH key */ public_key?: object; }; response: any; // Response structure will depend on the API }; /** * Retrieve snapshot for a specified virtual machine. Use this endpoint to view current VPS snapshot information. */ "vps_snapshots_get": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Create a snapshot of a specified virtual machine. A snapshot captures the state and data of the virtual machine at a specific point in time, allowing users to restore the virtual machine to that state if needed. This operation is useful for backup purposes, system recovery, and testing changes without affecting the current state of the virtual machine. **Creating new snapshot will overwrite the existing snapshot!** Use this endpoint to capture VPS state for backup and recovery purposes. */ "vps_snapshots_create": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Delete a snapshot of a specified virtual machine. Use this endpoint to remove VPS snapshots. */ "vps_snapshots_delete": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Restore a specified virtual machine to a previous state using a snapshot. Restoring from a snapshot allows users to revert the virtual machine to that state, which is useful for system recovery, undoing changes, or testing. Use this endpoint to revert VPS instances to previous saved states. */ "vps_snapshots_restore": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Start a specified virtual machine. If the virtual machine is already running, the request will still be processed without any effect. Use this endpoint to power on stopped VPS instances. */ "vps_virtual-machines_start": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Stop a specified virtual machine. If the virtual machine is already stopped, the request will still be processed without any effect. This is a compute-only power state change and does not affect billing. To stop future charges, disable auto-renewal on the owning subscription. Use this endpoint to power off running VPS instances. */ "vps_virtual-machines_stop": { params: { /** * Virtual Machine ID */ virtualMachineId: number; }; response: any; // Response structure will depend on the API }; /** * Start generating one or more images from a prompt and an image type for the specified WordPress installation. The generation runs asynchronously: the response is returned right away with `status: in-progress` and a `generation_id`. Poll GET /api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id} every few seconds until `status` is `completed` or `failed`. A completed generation returns temporary image URLs together with the time they expire; download the images before then. Images match the requested aspect ratio and are never smaller than the requested size; logos are transparent images cropped to the mark. Only one image generation can run per installation at a time: while one is still in progress the endpoint returns 409 without the ID of the running generation, so a caller that did not receive the `202` has to wait for it to finish (up to a few minutes) before starting a new one. The endpoint is limited to 10 requests per minute. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_ai-content_generate-images": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * What the image should show. For the logo type, the wordmark and mark to render. */ prompt: string; /** * Kind of image to generate. It sets the default size and cropping. */ image_type: string; /** * How many images to generate */ num_of_images?: number; /** * Output width in pixels. Defaults per image type and is ignored for the logo type. */ width?: number; /** * Output height in pixels. Defaults per image type and is ignored for the logo type. */ height?: number; /** * Style tokens appended to photographic prompts. Ignored for the logo type. */ style?: string; /** * Colour direction for the logo type only. It is not rendered as text. */ color_guidance?: string; }; response: any; // Response structure will depend on the API }; /** * Get the result of an AI content generation started for the specified WordPress installation, such as an image generation started with POST /api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate. While the generation is still running only `status: in-progress` is returned; poll every few seconds. Once `completed`, `result` holds the generated content shaped according to `type`: temporary image URLs together with the time they expire for `image-generation`, or the generated website document for `website-generation` (started from the Hostinger WordPress plugin). A `failed` generation has no `result`. Unknown or expired generation IDs return 404. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_ai-content_generation-result": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Generation ID returned when the generation was started */ generation_id: string; /** * Generation type to look up. When omitted, every generation type is checked. */ type?: string; }; response: any; // Response structure will depend on the API }; /** * Show the current AI option status for the Hostinger Tools plugin on the specified WordPress installation. Filter by `option` to return a single option, or omit it to return all options. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_ai-tools_show-option-status": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Filter the status by a single AI option. */ option?: string; }; response: any; // Response structure will depend on the API }; /** * Enable or disable an AI option for the Hostinger Tools plugin on the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_ai-tools_set-option-status": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * AI option name */ option: string; /** * Enable (true) or disable (false) the AI option. */ enable: boolean; }; response: any; // Response structure will depend on the API }; /** * Check whether one or more WordPress installations are valid and working correctly. Detects broken installations caused by missing files, broken plugins, themes and similar issues. Provide the WordPress installation (software) identifiers in the body. They can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_installations_check-if-are-valid": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifiers to validate. */ software_ids: array; /** * Force fresh validation without cache. Preferable for troubleshooting purposes. */ force?: boolean; }; response: any; // Response structure will depend on the API }; /** * Delete the specified WordPress installation, with optional file and database removal. This removes all associated components including plugins, themes, staging websites and any other related data. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_installations_delete": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Trigger a background scan to detect WordPress installations for the account. This operation is asynchronous: a successful response only means the scan has been queued. Poll GET /api/hosting/v1/wordpress/installations to fetch the detected installations once the scan completes. */ "wordpress_installations_detect": { params: { /** * username parameter */ username: string; }; response: any; // Response structure will depend on the API }; /** * Import WordPress website to the specified domain. WARNING: this overwrites the website's existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website's directory. */ "wordpress_installations_import-website": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Path to the WordPress archive file (relative to website root) */ archive_path: string; /** * Path to the database SQL file (relative to website root) */ sql_path: string; }; response: any; // Response structure will depend on the API }; /** * Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/orders/{order_id}/onboardings (`hosting_websites_start-setup`) and poll GET /api/hosting/v1/onboardings (`hosting_websites_list-setups`) with the `domain` filter until its `status` is `completed`. Send `type: headless` to turn a headless website (for example one created by `hosting_websites_start-setup` with `type: headless_empty`) into a headless WordPress website: WordPress is installed into the `cms` directory with the Hostinger headless MU plugin and the website is marked as a headless WordPress website. `directory` is not allowed with it. The target website must already be headless: the headless install rewrites the root `.htaccess`, so on any other website the request is rejected with 422. Call GET /api/hosting/v1/wordpress/installations (`wordpress_installations_list`) filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations (`wordpress_installations_list`) filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready. Returns 422 when the account already uses all the databases its plan allows, unless `database.name` is an existing database on the account. */ "wordpress_installations_install": { params: { /** * username parameter */ username: string; /** * Domain of the existing website where WordPress will be installed */ domain: string; /** * Title of the WordPress site */ site_title: string; /** * WordPress locale. Defaults to en_US when omitted. */ language?: string; /** * Installation kind; `default` when omitted. `headless` installs WordPress into the `cms` directory with the Hostinger headless MU plugin and marks the website as a headless WordPress website. Accepted only for a website that is already headless, e.g. one created by `POST /api/hosting/v1/orders/{order_id}/onboardings` (`hosting_websites_start-setup`) with `type: headless_empty`; any other website is rejected with 422. */ type?: string; /** * Installation subdirectory relative to the document root; omit for the root. Not allowed with `type: headless`, which always installs into `cms`. */ directory?: string; /** * When false (default), does not replace an existing installation. If WordPress is already installed on the domain/path, the async install job fails unless true. */ overwrite?: boolean; /** * WordPress core auto-update policy */ auto_updates?: string; /** * WordPress core version to install. If omitted, the latest core version compatible with the account vhost PHP version is selected. */ version?: string; /** * WordPress admin credentials */ credentials: object; /** * Optional. If the named database already exists on the account, it is used for this WordPress install. Otherwise a new database is created with this name, or with a generated name when database is omitted or null. A new database gets a random database user and counts toward the plan's database limit. */ database?: object; }; response: any; // Response structure will depend on the API }; /** * List WordPress installations on shared and cloud web hosting accounts (the `/api/hosting/v1` family, identified by `username`) accessible to the authenticated client. Agency Plan websites are not included. To work with WordPress on an Agency Plan website, list them with GET /api/agency-hosting/v1/websites?website_types=wordpress and read their details with GET /api/agency-hosting/v1/websites/{website_uid}/wordpress/settings. An account that only has Agency Plan websites receives an empty list from this endpoint. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a `valid` flag and, when invalid, a `validationError` describing why. */ "wordpress_installations_list": { params: { /** * Filter by specific username */ username?: string; /** * Filter by domain name (case-insensitive substring match) */ domain?: string; /** * Filter by ownership type. Defaults to "owned". Use "all" to include both owned and managed installations. */ ownership?: string; }; response: any; // Response structure will depend on the API }; /** * List available WordPress core updates for the specified installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_installations_list-core-updates": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Return a JWT token used to authenticate requests against the specified WordPress installation, including its MCP (Model Context Protocol) endpoint. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_installations_jwt-token": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Show the WordPress core version for the specified installation, along with known vulnerabilities affecting it. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_installations_show-core-version": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Update the WordPress core for the specified installation (minor update or a specific version). Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the update job has been queued. */ "wordpress_installations_update-core": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Update the minor version only. */ minor?: boolean; /** * Update to a specific WordPress core version. */ version?: string; }; response: any; // Response structure will depend on the API }; /** * Purge the LiteSpeed Cache for the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_litespeed-cache_purge-lite-speed": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Show the LiteSpeed Cache status for the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_litespeed-cache_show-lite-speed-status": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Create temporary auto-login links for the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_login_create-links": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Show the maintenance mode status for the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_maintenance_show-status": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Enable or disable maintenance mode for the specified WordPress installation, based on the `enabled` flag. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_maintenance_toggle": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Enable (true) or disable (false) maintenance mode for the WordPress installation. */ enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Show the Memcached object cache status for the specified WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_object-cache_show-memcached-status": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * Activate or deactivate the Memcached object cache for the specified WordPress installation, based on the `enabled` flag. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_object-cache_toggle-memcached": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Activate (true) or deactivate (false) the Memcached object cache for the WordPress installation. */ enabled: boolean; }; response: any; // Response structure will depend on the API }; /** * Activate an installed plugin on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the activation job has been queued. */ "wordpress_plugins_activate": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slug of the installed plugin to activate. */ plugin: string; }; response: any; // Response structure will depend on the API }; /** * Deactivate an installed plugin on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the deactivation job has been queued. */ "wordpress_plugins_deactivate": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slug of the installed plugin to deactivate. */ plugin: string; }; response: any; // Response structure will depend on the API }; /** * Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website's directory. The plugin will be activated and made available in the WordPress admin panel. */ "wordpress_plugins_deploy": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Slug of the plugin */ slug: string; /** * Relative path to the plugin directory from wp-content/plugins */ plugin_path: string; }; response: any; // Response structure will depend on the API }; /** * Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready. */ "wordpress_plugins_install": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Plugin slugs to install. Use GET /api/hosting/v1/wordpress/plugins to discover available slugs. */ plugins: array; }; response: any; // Response structure will depend on the API }; /** * List plugins recommended for installation on a WordPress installation that are not yet installed. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_plugins_list": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * List plugins installed on a WordPress installation, including their status, available updates and known vulnerabilities. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_plugins_list-installed": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Filter installed plugins by category. */ category?: string; }; response: any; // Response structure will depend on the API }; /** * Search the WordPress.org plugin directory for plugins available to install. Use the returned `slug` values with POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install. */ "wordpress_plugins_search": { params: { /** * Search term to match against plugin names. Minimum 3 characters. */ search: string; }; response: any; // Response structure will depend on the API }; /** * List curated plugin suggestions grouped by website type. Use the returned `slug` values with POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install. */ "wordpress_plugins_list-suggested": { params: { /** * Optionally scope suggestions to a specific order. */ order_id?: number; }; response: any; // Response structure will depend on the API }; /** * Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check. */ "wordpress_plugins_check-if-woo-commerce-is-installed": { params: { /** * Filter by domain name (case-insensitive substring match) */ domain?: string; }; response: any; // Response structure will depend on the API }; /** * Uninstall one or more plugins from a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the uninstall job has been queued. */ "wordpress_plugins_uninstall": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slugs of the installed plugins to uninstall. */ plugins: array; }; response: any; // Response structure will depend on the API }; /** * Update a Hostinger plugin to its latest version on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the update job has been queued. */ "wordpress_plugins_update-hostinger": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slug of the Hostinger plugin to update to its latest version. */ slug: string; }; response: any; // Response structure will depend on the API }; /** * Update one or more installed plugins to their latest version on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the update job has been queued. */ "wordpress_plugins_update": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slugs of the installed plugins to update to their latest version. */ plugins: array; }; response: any; // Response structure will depend on the API }; /** * Activate an installed theme on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the activation job has been queued. */ "wordpress_themes_activate": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slug of the installed theme to activate. */ theme: string; }; response: any; // Response structure will depend on the API }; /** * Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website's directory. The theme can be optionally activated after deployment. */ "wordpress_themes_deploy": { params: { /** * username parameter */ username: string; /** * Domain name */ domain: string; /** * Slug of the theme */ slug: string; /** * Relative path to the theme directory from wp-content/themes */ theme_path: string; /** * Whether to activate the theme after deployment */ is_activated?: boolean; }; response: any; // Response structure will depend on the API }; /** * Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready. */ "wordpress_themes_install": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slug of the theme to install. Hostinger theme slugs (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme) trigger the custom installer and forward the optional palette/layout/font fields; any other WordPress theme slug uses the standard installer and ignores those fields. */ theme: string; /** * Palette identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted. */ palette?: string; /** * Layout identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted. */ layout?: string; /** * Font identifier. Only applied when the theme is a Hostinger theme; the default is used when omitted. */ font?: string; }; response: any; // Response structure will depend on the API }; /** * List themes installed on a WordPress installation, including their status, available updates and known vulnerabilities. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). */ "wordpress_themes_list-installed": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; }; response: any; // Response structure will depend on the API }; /** * List WordPress themes available to install. Use the returned `slug` values with POST /api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install. */ "wordpress_themes_list": { params: { /** * Optionally scope themes to a specific order. */ order_id?: number; /** * Search term to match against theme names. */ search?: string; }; response: any; // Response structure will depend on the API }; /** * Uninstall one or more themes from a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the uninstall job has been queued. */ "wordpress_themes_uninstall": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slugs of the installed themes to uninstall. */ themes: array; }; response: any; // Response structure will depend on the API }; /** * Update one or more installed themes to their latest version on a WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). This operation is asynchronous: a successful response only means the update job has been queued. */ "wordpress_themes_update": { params: { /** * username parameter */ username: string; /** * WordPress installation (software) identifier */ software: string; /** * Slugs of the installed themes to update to their latest version. */ themes: array; }; response: any; // Response structure will depend on the API }; }