---
title: "Get a suite"
method: GET
path: "/api/v2/synthetics/suites/{public_id}"
tags: ["Synthetics"]
---

# Get a suite

`GET /api/v2/synthetics/suites/{public_id}`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/synthetics/suites/{public_id}`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `synthetics_read`

## Path parameters

- `public_id` string, required

## 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

- `404`: API error response.
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)