The command patch can be used to updates selected attributes of a Synthetic test, only one attribute can be patched each time.
synctl patch test id [options]
-h, --help show this help message and exit
--verify-tls verify tls certificate
--active <boolean> set active
--frequency <int> set frequency
--location <id> [<id> ...] set location
--description <string> set description
--label <string> set label
--retries <int> set retries, min is 0 and max is 2
--retry-interval <int> set retry-interval, min is 1, max is 10
--timeout <num>ms|s|m set timeout, accept <number>(ms|s|m)
--custom-properties <key>=<value> set custom property, should be <key,value> pair
--use-env, -e <name> use a config hostname
--host <host> set hostname
--token <token> set token
--url <url> HTTP URL
--follow-redirect <boolean> set follow-redirect
--mark-synthetic-call <boolean> set markSyntheticCall
--expect-status <int> set expected HTTP status code
--operation <method> HTTP request methods, GET, POST, HEAD, PUT, etc.
--validation-string <string> set validation-string
--expect-status <int> expected status code, Synthetic test will fail if response status is not equal to it, default 200
--expect-json <string> An optional object to be used to check against the test response object
--expect-match <string> An optional regular expression string to be used to check the test response
--expect-exists <string> An optional list of property labels used to check if they are present in the test response object
--expect-not-empty <string> An optional list of property labels used to check if they are present in the test response object with a non-empty value
--allow-insecure <boolean> if set to true then allow insecure certificates
--script <file> load script (.js) from file
--bundle <bundle> Synthetic bundle test script, support zip file (.zip) path or zip file content encoded with base64
--bundle-entry-file <file-name> Synthetic bundle test entry file, e.g, myscript.js
--mark-synthetic-call <boolean> set markSyntheticCall
--script <file> load script (.js) from file
--bundle <bundle> Synthetic bundle test script, support zip file (.zip) path or zip file content encoded with base64
--bundle-entry-file <file-name> Synthetic bundle test entry file, e.g, myscript.js
--browser <string> browser type, support chrome and firefox
--record-video <boolean> enable/disable record video, false by default
--mark-synthetic-call <boolean> set markSyntheticCall
--url <url> HTTP URL
--mark-synthetic-call <boolean> set markSyntheticCall
--record-video <boolean> enable/disable record video, false by default
--browser <string> browser type, support chrome and firefox
--mark-synthetic-call <boolean> set markSyntheticCall
--script <file> load script (.side) from file
--mark-synthetic-call <boolean> set markSyntheticCall
--record-video <boolean> enable/disable record video, false by default
--browser <string> browser type, support chrome and firefox
--mark-synthetic-call <boolean> set markSyntheticCall
--hostname <host> set hostname for ssl test
--port <int> set port
--remaining-days-check <int> set days remaining before expiration of SSL certificate
# Patch test label to simple-ping.
synctl patch test <synthetic-id> --label simple-ping
# Set test frequency to 5 min
synctl patch test <synthetic-id> --frequency 5
# Set test description to "New Description".
synctl patch test <synthetic-id> --description "New Description"
# Set test location id to id1, id2...
synctl patch test <synthetic-id> --lo <id1> <id2> ...
# Set test retries to 2
synctl patch test <synthetic-id> --retries 2
# Set test retry interval to 5, unit of retry interval is second.
synctl patch test <synthetic-id> --retry-interval 5
# Set test timeout to 120s
synctl patch test <synthetic-id> --timeout 120s
# Pause Synthetic test
synctl patch test <synthetic-id> --active false
# Set custom properties of a test
synctl patch test <synthetic-id> --custom-properties key=value
# Set multiple custom properties of a test
synctl patch test <synthetic-id> --custom-properties "key1=value1,key2=value2,key3=value3"
# Set URL of API Simple to `https://www.ibm.com`
synctl patch test <synthetic-id> --url https://www.ibm.com
# Set mark synthetic call to `True`.
synctl patch test <synthetic-id> --mark-synthetic-call True
# Set HTTP operation to POST
synctl patch test <synthetic-id> --operation POST
# Set follow redirect of API Simple to `true`
synctl patch test <synthetic-id> --follow-redirect true
# Set expect status of API Simple to 200
synctl patch test <synthetic-id> --expect-status 200
# Set validation string of API Simple to `synthetic-test`
synctl patch test <synthetic-id> --validation-string "synthetic-test"
# Update synthetic test with new script
synctl patch test <synthetic-id> --script new-api-script.js
# Update bundle test with a zip file
synctl patch test <synthetic-id> --bundle synthetic.zip
# Update bundle test using base64 string
PATCH_BASE64_STR=`cat bundle.zip|base64`
synctl patch test <synthetic-id> --bundle "${PATCH_BASE64_STR}"
# Set entry file of bundle test
synctl patch test <synthetic-id> --bundle-entry-file bundle-test/index.js
# Set browser to firefox
synctl patch test <synthetic-id> --browser firefox
# Set multiple custom properties of a test
synctl patch test <synthetic-id> --custom-properties "key1=value1,key2=value2,key3=value3"
# Set URL of Webpage Simple to `https://www.ibm.com`
synctl patch test <synthetic-id> --url https://www.ibm.com
# Set browser to firefox
synctl patch test <synthetic-id> --browser firefox
# Update synthetic test with new script
synctl patch test <synthetic-id> --script seleniumide-script.side
# Set record video true
synctl patch test <synthetic-id> --record-video true
# Set browser to firefox
synctl patch test <synthetic-id> --browser firefox
# Set hostname of a SSLCertificate test
synctl patch test <synthetic-id> --hostname www.ibm.com
# Set port of a SSLCertificate test
synctl patch test <synthetic-id> --port 443
# Set remaining days of a SSLCertificate test
synctl patch test <synthetic-id> --remaining-days-check 30