Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Synthetics

Pause or start a test

Pause or start a Synthetic test by changing the status.

put/api/v1/synthetics/tests/{public_id}/status

Path parameters

public_idstring required

The public ID of the Synthetic test to update.

Request body

new_status'live' | 'paused'

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

Example request

{
  "new_status": "live"
}

Response

OK - Returns a boolean indicating if the update was successful.

boolean required