---
title: "Patch a test suite"
method: PATCH
path: "/api/v2/synthetics/suites/{public_id}/jsonpatch"
tags: ["Synthetics"]
---

# Patch a test suite

`PATCH /api/v2/synthetics/suites/{public_id}/jsonpatch`

Patch a Synthetic test suite using JSON Patch (RFC 6902).
Use partial updates to modify only specific fields of a test suite.

Common operations include:
- Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}`
- Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}`
- Remove fields: `{"op": "remove", "path": "/message"}`

## Path parameters

- `public_id` string, required

## Request body

- SuiteJsonPatchRequest — JSON Patch request for a Synthetic test suite.
  - `data` SuiteJsonPatchRequestData, required — Data object for a JSON Patch request on a Synthetic test suite.
    - `attributes` SuiteJsonPatchRequestDataAttributes — Attributes for a JSON Patch request on a Synthetic test suite.
      - `json_patch` JsonPatchOperation[] — JSON Patch operations following RFC 6902.
        - `op` 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test', required — The operation to perform.
        - `path` string, required — A JSON Pointer path (e.g., "/name", "/value/secure").
        - `value` unknown
    - `type` 'suites_json_patch' — Type for a JSON Patch request on a Synthetic test suite, `suites_json_patch`.

## Response `200`

OK

- SyntheticsSuiteResponse — Synthetics suite response
  - `data` SyntheticsSuiteResponseData — Synthetics suite response data
    - `attributes` SyntheticsSuite — Object containing details about a Synthetic suite.
      - `message` string — Notification message associated with the suite.
      - `monitor_id` integer — The associated monitor ID.
      - `name` string, required — Name of the suite.
      - `options` SyntheticsSuiteOptions, required — Object describing the extra options for a Synthetic suite.
        - `alerting_threshold` number, double — Percentage of critical tests failure needed for a suite to fail.
      - `public_id` string — The public ID for the test.
      - `tags` string[] — Array of tags attached to the suite.
      - `tests` SyntheticsSuiteTest[], required — Array of Synthetic tests included in the suite.
        - `alerting_criticality` 'ignore' | 'critical' — Alerting criticality for each the test.
        - `public_id` string, required — The public ID of the Synthetic test included in the suite.
      - `type` 'suite', required — Type of the Synthetic suite, `suite`.
    - `id` string — The public ID for the suite.
    - `type` 'suites' — Type for the Synthetics suites responses, `suites`.

## Other responses

- `400` — API error response.
- `429` — Too many requests

---

[API](https://skmtc.net/datadog/apis/api-v2.md) · [All operations](https://skmtc.net/datadog/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v2/versions/da68bf029e4c/schema)