Add domain to monitoring

This function creates a Site Quality Monitoring project. A project bundles together one or more URLs with a shared domain for monitoring.

SecurityBasicAuth
Request
query Parameters
name
required
string

The name of the project to create.

Example: name=MyProject
url
required
string

The URL to monitor.

Example: url=https://example.com
standard_alerting
integer or null
Default: null

Whether to enable standard email alerts.

  • 1 - Enable standard alerting.
  • 0 - Do not enable standard alerting.
  • null - Do not enable standard alerting.
Enum: 0 1 null
Example: standard_alerting=0
system_type
string
Default: "Website"

The monitoring template to use for the project.

Example: system_type=Website
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_project
Request samples
uapi --output=jsonpretty \
  --user=username \
  SiteQuality \
  create_project \
  name=MyProject \
  url='https://example.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "create_project",
  • "module": "SiteQuality",
  • "result": {
    • "data": {
      • "id": 1754,
      • "identifier": "pro-1754",
      • "location": "us",
      • "name": "MyProject",
      • "role": {
        • "id": 0,
        • "name": "Owner"
        },
      • "systems": [
        • {
          • "name": "MyProject",
          • "description": null,
          • "domain": "https://example.com",
          • "id": 2542,
          • "interval": "hour",
          • "limits": {
            • "maximumCrawlDepth": 500
            },
          • "system_type": {
            • "name": "Website",
            • "id": 1,
            • "fixedComponents": true
            }
          }
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}