Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Synthetics

Patch a Synthetic test

Patch the configuration of a Synthetic test with partial data.

patch/api/v1/synthetics/tests/{public_id}

Path parameters

public_idstring required

The public ID of the test to patch.

Request body

Example request

{
  "data": [
    {
      "op": "replace",
      "path": "/name",
      "value": "New test name"
    },
    {
      "op": "remove",
      "path": "/config/assertions/0"
    }
  ]
}

Response

OK

locationsstring[]

Array of locations used to run the test.

messagestring

Notification message associated with the test.

monitor_idinteger

The associated monitor ID.

namestring

Name of the test.

public_idstring

The test public ID.

status'live' | 'paused'

Define whether you want to start (live) or pause (paused) a Synthetic test.

subtype'http' | 'ssl' | 'tcp' | 'dns' | 'multi' | 'icmp' | 'udp' | 'websocket' | 'grpc'

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.

tagsstring[]

Array of tags attached to the test.

type'api' | 'browser' | 'mobile' | 'network'

Type of the Synthetic test.

Example response

{
  "config": {
    "assertions": [],
    "configVariables": [
      {
        "name": "VARIABLE_NAME",
        "type": "text"
      }
    ],
    "request": {
      "basicAuth": {
        "password": "PaSSw0RD!",
        "type": "web",
        "username": "my_username"
      },
      "bodyType": "text/plain",
      "callType": "unary",
      "mcpProtocolVersion": "2025-06-18",
      "proxy": {
        "url": "https://example.com"
      },
      "service": "Greeter",
      "toolName": "search",
      "url": "https://example.com"
    },
    "variables": [
      {
        "name": "VARIABLE_NAME",
        "type": "text"
      }
    ]
  },
  "locations": [
    "aws:eu-west-3"
  ],
  "options": {
    "ci": {
      "executionRule": "blocking"
    },
    "device_ids": [
      "chrome.laptop_large"
    ],
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ],
    "rumSettings": {
      "applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "clientTokenId": 12345,
      "isEnabled": true
    },
    "scheduling": {
      "timeframes": [
        {
          "day": 1,
          "from": "07:00",
          "to": "16:00"
        },
        {
          "day": 3,
          "from": "07:00",
          "to": "16:00"
        }
      ],
      "timezone": "America/New_York"
    }
  },
  "status": "live",
  "steps": [
    {
      "type": "assertElementContent"
    }
  ],
  "subtype": "http"
}