API Explorer: /schedules/{scheduleId}

To update a schedule, use PATCH to change the provided configuration for a given schedule (you need to know the scheduleId). The sample code updates a schedule with an ID of 5c83e5610bd29075e16b2794 to not run by setting enabled to false. The sample code updates the schedule created in the Create a Schedule for Test section.

Caution: If you do not know the scheduleId of the test schedule, use List Schedules to return a list of your created test schedules.

curl 'https://a.blazemeter.com/api/v4/schedules/5c83e5610bd29075e16b2794' \
  -X PATCH \
  -H 'Content-Type: application/json' \
  --user 'api_key_id:api_key_secret' \
  -d '{"enabled":false}'

Update Schedule Request Attributes

Attributes

• enabledboolean

  Denotes if the schedule is active (if true) or not (if false)

{
  "enabled": false
}

Update Schedule Response Attributes

See the The Schedule Object for a full breakdown of the attributes.

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": "5c83e5610bd29075e16b2794",
        "cron": "0 0 * * 1-5",
        "nextRun": 1552262400,
        "enabled": false,
        "type": "testRun",
        "created": 1552147809,
        "updated": 1552150058,
        "testId": 1234567,
        "createdById": 123456,
        "lastUpdatedById": 123456
    }
}