# SiteQuality

The SiteQuality module for UAPI.

## Add domain to monitoring

 - [POST /SiteQuality/create_project](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-create_project.md): This function creates a Site Quality Monitoring project. A project bundles together one or more URLs with a shared domain for monitoring.

## Register cPanel user for monitoring

 - [POST /SiteQuality/create_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-create_site_quality_user.md): This function creates a Site Quality Monitoring user account associated with a cPanel user account.

## Delete Site Quality Monitoring account

 - [GET /SiteQuality/delete_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-delete_site_quality_user.md): This function initiates the deletion of the Site Quality Monitoring user account associated with a cPanel user account.

## Return all projects' monitoring results

 - [POST /SiteQuality/get_all_scores](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-get_all_scores.md): This function returns information about the cPanel user's Site Quality Monitoring projects' most recent monitoring check results.

## Return koality authentication token

 - [GET /SiteQuality/get_app_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-get_app_token.md): This function returns the long-lived application token used to authenticate with koality's authentication servers.

## Validate monitoring account existence

 - [GET /SiteQuality/has_site_quality_user](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-has_site_quality_user.md): This function returns whether the cPanel user has an associated Site Quality Monitoring account.

## Validate monitoring account enablement

 - [GET /SiteQuality/is_site_quality_user_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-is_site_quality_user_enabled.md): This function verifies that koality has enabled the cPanel user's Site Quality Monitoring account.

## Remove monitoring user from cPanel configuration

 - [GET /SiteQuality/reset_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-reset_config.md): This function will remove Site Quality Monitoring account data from the cPanel user's configuration.


* This function will prevent cPanel & WHM from automatically logging the user into their Site Quality Monitoring account.
* This function does not delete the Site Quality Monitoring account from the koality servers.

## Request activation email

 - [GET /SiteQuality/send_activation_email](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-send_activation_email.md): This function sends a Site Quality Monitoring activation email to the currently-authenticated Site Quality Monitoring user.


This email contains the Site Quality Monitoring activation code.

## Update domain name in Site Quality Monitoring project

 - [POST /SiteQuality/update_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-update_domain.md): This function updates the domain name for a Site Quality Monitoring project. It searches through all projects owned by the user to find systems that match the specified old domain and updates them to use the new domain. This is typically used when a website's domain name changes and the monitoring configuration needs to be updated accordingly.

## Validate activation code

 - [GET /SiteQuality/verify_code](https://api.docs.cpanel.net/specifications/cpanel.openapi/sitequality/sitequality-verify_code.md): This function validates the activation code in a cPanel user's Site Quality Monitoring registration email.