Register cPanel user for monitoring

This function creates a Site Quality Monitoring user account associated with a cPanel user account.

SecurityBasicAuth

Request

query Parameters

email required	string The cPanel account's email address. Example: email=username@example.com
password	string The account's password. Note: If no password is given, one is auto-generated. The system does not save this value. Example: password=An3xample!?

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

post/SiteQuality/create_site_quality_user

Request samples

CLI
URL
HTTP Request (Wire Format)
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  SiteQuality \
  create_site_quality_user \
  email=username@example.com

Response samples

application/json

{"apiversion": 3,
"func": "create_site_quality_user",
"module": "SiteQuality",
"result": {"data": {"app_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
"username": "username@example.com",
"enabled": true
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}