Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Site Templates

Create new site from a site template

Kicks off the creation of a task to create a new site from a site template

post/v1/sites/templates/{template_id}/sites

Path parameters

template_idstring uuid required

Request body

namestring required

WordPress Site Title

locationinteger

Which Rocket.net Point of Presence to create the site at

restricted_locationinteger

If you have dedicated locations, you can use these by ID to add sites at those dedicated locations. (When passed, do not pass location)

sub_pathstring

If the site should be installed outside of public_html, which folder (this is rare)

labelstring

Label for the site (can be used to look up sites)

metadataSiteMetadata

Example request

{
  "sub_path": "blog",
  "label": "agencypartner1::site1::abcd",
  "metadata": {
    "key": "value"
  },
  "template_replacements": [
    {
      "key": "__contact_email__",
      "value": "hello@rocket.net"
    }
  ]
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "task_level": "account"
  }
}