Update a site

Update an existing site

Usage notes:

  • urls is required. URLs without a url_id will be created as new URLs. Any existing URLs that are not present in the urls array will be deleted.
  • When settings is not present, settings will not be modified.
  • When settings is present, they will override all existing settings.
  • settings.synthetic.test_times can be an empty array, which means the site will not have any scheduled testing.

Example request body:

{
  "name": "Radio NZ",
  "type": "competitor",
  "category": "News",
  "color": "#ff00ff",
  "urls": [
    {
      "url_id": 116412,
      "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
    }
  }
}

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!