Skip to main content

synthetics_suite_jsonpatches

Creates, updates, deletes, gets or lists a synthetics_suite_jsonpatches resource.

Overview

Namesynthetics_suite_jsonpatches
TypeResource
Iddatadog.monitoring.synthetics_suite_jsonpatches

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
patch_test_suiteupdatepublic_id, dataPatch a Synthetic test suite using JSON Patch (RFC 6902).<br />Use partial updates to modify only specific fields of a test suite.<br /><br />Common operations include:<br />- Replace field values: &#123;"op": "replace", "path": "/name", "value": "new_name"&#125;<br />- Add/update tags: &#123;"op": "add", "path": "/tags/-", "value": "new_tag"&#125;<br />- Remove fields: &#123;"op": "remove", "path": "/message"&#125;

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
public_idstringThe public ID of the Synthetic test suite to patch.
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

UPDATE examples

Patch a Synthetic test suite using JSON Patch (RFC 6902).<br />Use partial updates to modify only specific fields of a test suite.<br /><br />Common operations include:<br />- Replace field values: &#123;"op": "replace", "path": "/name", "value": "new_name"&#125;<br />- Add/update tags: &#123;"op": "add", "path": "/tags/-", "value": "new_tag"&#125;<br />- Remove fields: &#123;"op": "remove", "path": "/message"&#125;

UPDATE datadog.monitoring.synthetics_suite_jsonpatches
SET
data = '{{ data }}'
WHERE
public_id = '{{ public_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;