synthetics_suite_jsonpatches
Creates, updates, deletes, gets or lists a synthetics_suite_jsonpatches resource.
Overview
| Name | synthetics_suite_jsonpatches |
| Type | Resource |
| Id | datadog.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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
patch_test_suite | update | public_id, data | 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: {"op": "replace", "path": "/name", "value": "new_name"}<br />- Add/update tags: {"op": "add", "path": "/tags/-", "value": "new_tag"}<br />- Remove fields: {"op": "remove", "path": "/message"} |
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.
| Name | Datatype | Description |
|---|---|---|
public_id | string | The public ID of the Synthetic test suite to patch. |
site | string | The 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_test_suite
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: {"op": "replace", "path": "/name", "value": "new_name"}<br />- Add/update tags: {"op": "add", "path": "/tags/-", "value": "new_tag"}<br />- Remove fields: {"op": "remove", "path": "/message"}
UPDATE datadog.monitoring.synthetics_suite_jsonpatches
SET
data = '{{ data }}'
WHERE
public_id = '{{ public_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;