Return Site Publisher websites' information

This function lists information for the cPanel account's Site Publisher websites.

Note:

To retrieve the list of Site Publisher website information, the function queries the configurations.json file in each domain's document root. For more information, read our Guide to Site Publisher Templates documentation.

Important:

When you disable the Web Server role, the system disables this function.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/SiteTemplates/list_user_settings

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  SiteTemplates \
  list_user_settings

Response samples

application/json

{"apiversion": 3,
"func": "list_user_settings",
"module": "SiteTemplates",
"result": {"data": [{"documentroot": "/home/example/public_html",
"domain": "example.com",
"homedir": "/home/example",
"serveralias": ["www.example.com"
],
"template_settings": {"is_empty": 0,
"path": "/usr/local/cpanel/3rdparty/share/site_templates/",
"template": "mytemplate"
},
"type": "main"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}