Return Sitejet domains

This function returns the Sitejet domains' information for the cPanel account.

SecurityBasicAuth
Request
query Parameters
domain
string

The single domain to return Sitejet information.

Example: domain=example.com
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/Sitejet/get_all_user_sitejet_info
Request samples
uapi --output=jsonpretty \
  --user=username \
  Sitejet \
  get_all_user_sitejet_info
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "get_all_user_sitejet_info",
  • "module": "Sitejet",
  • "result": {
    • "data": [
      • {
        • "domain": "example.com",
        • "metadata": {
          • "company": "cPanel",
          • "cpanelDomainGUID": "example.com",
          • "fullcms": 1,
          • "language": "en",
          • "latest_publish_date": 0,
          • "publish_status": 1,
          • "templateId": 333333,
          • "websiteId": 444444
          },
        • "quota": {
          • "available_space": 1024,
          • "can_backup": 1,
          • "is_empty_docroot": 1,
          • "required_space": 64
          },
        • "redirection_enabled": 1,
        • "shared_doc_root": 1,
        • "is_restore_point_available": 1,
        • "status": {
          • "has_sitejet_published": 1,
          • "has_sitejet_templateId": 1,
          • "has_sitejet_website": 1,
          • "is_sitejet": 1
          }
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}