Create a site

📘
Important
When a settings object is provided, the site will not inherit any settings from the team it belongs to. This allows you to create sites with regions and test profiles that are not selected in your team settings.
When a settings object is not provided, the site will inherit the team's regions and test profiles, but it will not inherit test times. Test times will be empty, and the site will not initially have any scheduled testing after being created with this endpoint.

Example JSON request object:

{
  "name": "SpeedCurve",
  "type": "production",
  "urls": [
    {
      "url": "https://www.speedcurve.com/about",
      "label": "About"
    },
    {
      "url": "https://www.speedcurve.com/blog",
      "label": "Blog",
			"script": "navigate\t%URL%\nclick\tid=submit",
      "auth": {
        "username": "darthvader",
        "password": "p0wer0fTheF0rce"
      }
    }
  ]
}

A settings object can optionally be provided. It can contain the following keys:

synthetic.regions - Required. See the Test agent locations/regions page for a list of region IDs.
synthetic.test_profiles - Required. Test profile names can be found in the Settings page of the SpeedCurve app.
synthetic.test_times - Required. Times must be in hh:mm format. An empty array can be specified to disable scheduled testing.
synthetic.test_runs - Optional. Should be an integer between 1-9.

{
  "name": "Radio NZ",
  "type": "competitor",
  "category": "News",
  "color": "#ff00ff",
  "urls": [
    {
      "url": "https://www.rnz.co.nz/",
      "label": "Home"
    },
    {
      "url": "https://www.rnz.co.nz/programmes/the-detail/story/2018837367/so-long-dr-ashley-bloomfield",
      "label": "Article"
    }
  ],
  "settings": {
    "synthetic": {
      "regions": [
        {
          "region_id": "ap-southeast-2",
        }
      ],
      "test_profiles": [
        {
          "name": "Desktop Slow"
        },
        {
          "name": "Firefox"
        },
        {
          "name": "Mobile Slow"
        }
      ],
      "test_times": [
        {
          "time": "02:40"
        },
        {
          "time": "12:10"
        }
      ],
      "test_runs": 5
    }
  }
}