DAdatadog
Synthetics

Pause or start a test

Pause or start a Synthetic test by changing the status.

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

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/synthetics/tests/{public_id}/status
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: synthetics_write

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

Changes

No recorded changes to this operation across all 1 revision of this API.