v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Synthetics

Patch a test suite

Patch a Synthetic test suite using JSON Patch (RFC 6902). Use partial updates to modify only specific fields of a test suite.

Common operations include:

Replace field values: {"op": "replace", "path": "/name", "value": "new_name"}
Add/update tags: {"op": "add", "path": "/tags/-", "value": "new_tag"}
Remove fields: {"op": "remove", "path": "/message"}

patch/api/v2/synthetics/suites/{public_id}/jsonpatch

Path parameters

public_idstring required

Example:123-abc-456

The public ID of the Synthetic test suite to patch.

Request body

Example request

{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "suites_json_patch"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "message": "Notification message",
      "monitor_id": 12345678,
      "name": "Example suite name",
      "public_id": "123-abc-456",
      "tags": [
        "env:production"
      ],
      "tests": [
        {
          "alerting_criticality": "critical"
        }
      ],
      "type": "suite"
    },
    "id": "123-abc-456",
    "type": "suites"
  }
}