Sign in

v52

OpenAPI 3.0.0raw.githubusercontent.com2026-08-03269339953.6 KB
Agency Hosting: Website Setups

Provision a new Agency Plan website

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.

post/api/agency-hosting/v1/orders/{order_id}/websites/setups

Path parameters

order_idinteger required
Example:123456

Agency Plan order ID

Request body

datacenter_codestring required

Datacenter code where the website should be provisioned. Available codes depend on live capacity and are not a fixed set.

flavorstring required

Setup flavor: a specific WordPress version in the format wp-<major>.<minor> or wp-<major>.<minor>.<patch> (e.g. wp-6.8.2), or php-fpm for a plain PHP stack. Generic versions like wp-latest are not allowed.

domainstring nullable

Primary domain to attach to the website. Omit or set to null to get a free auto-generated *.hostingersite.com subdomain instead.

type'horizons' | 'node-static' nullable

Website type

Example request

{
  "datacenter_code": "us-east",
  "flavor": "wp-6.8.2",
  "settings": {
    "php": {
      "version": "8.3"
    }
  },
  "domain": "example.com",
  "type": "node-static",
  "wordpress": {
    "language": "en_US",
    "title": "My Blog",
    "admin": {
      "user": "admin",
      "password": "S3cureP@ssw0rd",
      "email": "admin@example.com"
    }
  },
  "clone": {
    "website_uid": "zpwlGlp19"
  },
  "derive_domain": {
    "from_vhost": {
      "username": "u123456789",
      "vhost": "example.com"
    }
  }
}

Response

Success response

setup_uuidstring

UUID tracking the asynchronous website setup process

Example response

{
  "setup_uuid": "0193b6d4-fabb-70e0-8ea4-cfe060a45898"
}