Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-02 11:31:50.129984",
"spec_repo_commit": "ab77d015"
"regenerated": "2025-07-02 12:38:43.717493",
"spec_repo_commit": "4fd1c189"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-02 11:31:50.146274",
"spec_repo_commit": "ab77d015"
"regenerated": "2025-07-02 12:38:43.733432",
"spec_repo_commit": "4fd1c189"
}
}
}
102 changes: 95 additions & 7 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33427,6 +33427,86 @@ paths:
operator: OR
permissions:
- synthetics_write
/api/v1/synthetics/tests/search:
get:
description: Search for Synthetic tests and Test Suites.
operationId: SearchTests
parameters:
- description: If true, include the full configuration for each test in the
response.
in: query
name: include_full_config
required: false
schema:
type: boolean
- description: If true, returns suites instead of tests.
in: query
name: search_suites
required: false
schema:
type: boolean
- description: If true, return only facets instead of full test details.
in: query
name: facets_only
required: false
schema:
type: boolean
- description: The offset from which to start returning results.
in: query
name: start
required: false
schema:
default: 0
format: int64
type: integer
- description: The maximum number of results to return.
in: query
name: count
required: false
schema:
default: 50
format: int64
type: integer
- description: The sort order for the results (e.g., 'name,asc' or 'name,desc').
in: query
name: sort
required: false
schema:
default: name,asc
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SyntheticsListTestsResponse'
description: OK - Returns the list of Synthetic tests matching the search.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- synthetics_read
summary: Search Synthetic tests
tags:
- Synthetics
x-permission:
operator: OR
permissions:
- synthetics_read
/api/v1/synthetics/tests/trigger:
post:
description: Trigger a set of Synthetic tests.
Expand Down Expand Up @@ -37222,13 +37302,21 @@ tags:
name: Slack Integration
- description: Take graph snapshots using the API.
name: Snapshots
- description: "Datadog Synthetic Monitoring uses simulated user requests and browser
rendering to help you ensure uptime,\nidentify regional issues, and track your
application performance. Synthetic tests come in\ntwo different flavors, [API
tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)\nand [browser
tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog\u2019s
API to\nmanage both test types programmatically.\n\nFor more information, see
the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/)."
- description: 'Datadog Synthetic Monitoring uses simulated user requests and browser
rendering to help you ensure uptime,

identify regional issues, and track your application performance. Synthetic tests
come in

two different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)

and [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You
can use Datadog''s API to

manage both test types programmatically.


For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/).'
name: Synthetics
- description: 'The tag endpoint allows you to assign tags to hosts,

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2025-07-01T15:52:56.329Z

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-12-09T11:18:22.632Z
2025-07-01T15:52:56.929Z

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions examples/v1/synthetics/SearchTests.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Search Synthetic tests returns "OK - Returns the list of Synthetic tests matching the search." response

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
p api_instance.search_tests()
13 changes: 13 additions & 0 deletions examples/v1/synthetics/SearchTests_195957771.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Search Synthetic tests with boolean query parameters

require "datadog_api_client"
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
opts = {
include_full_config: true,
search_suites: true,
facets_only: true,
start: 10,
count: 5,
sort: "name,desc",
}
p api_instance.search_tests(opts)
8 changes: 8 additions & 0 deletions features/scenarios_model_mapping.rb
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,14 @@
"public_id" => "String",
"body" => "SyntheticsMobileTest",
},
"v1.SearchTests" => {
"include_full_config" => "Boolean",
"search_suites" => "Boolean",
"facets_only" => "Boolean",
"start" => "Integer",
"count" => "Integer",
"sort" => "String",
},
"v1.TriggerTests" => {
"body" => "SyntheticsTriggerBody",
},
Expand Down
26 changes: 25 additions & 1 deletion features/v1/synthetics.feature
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Feature: Synthetics
flavors, [API
tests](https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest) and
[browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You
can use Datadogs API to manage both test types programmatically. For
can use Datadog's API to manage both test types programmatically. For
more information, see the [Synthetic Monitoring
documentation](https://docs.datadoghq.com/synthetics/).

Expand Down Expand Up @@ -790,6 +790,30 @@ Feature: Synthetics
When the request is sent
Then the response status is 200 OK - Returns a boolean indicating if the update was successful.

@generated @skip @team:DataDog/synthetics-ct
Scenario: Search Synthetic tests returns "Not found" response
Given new "SearchTests" request
When the request is sent
Then the response status is 404 Not found

@generated @skip @team:DataDog/synthetics-ct
Scenario: Search Synthetic tests returns "OK - Returns the list of Synthetic tests matching the search." response
Given new "SearchTests" request
When the request is sent
Then the response status is 200 OK - Returns the list of Synthetic tests matching the search.

@team:DataDog/synthetics-ct
Scenario: Search Synthetic tests with boolean query parameters
Given new "SearchTests" request
And request contains "include_full_config" parameter with value true
And request contains "search_suites" parameter with value true
And request contains "facets_only" parameter with value true
And request contains "start" parameter with value 10
And request contains "count" parameter with value 5
And request contains "sort" parameter with value "name,desc"
When the request is sent
Then the response status is 200 OK - Returns the list of Synthetic tests matching the search.

@generated @skip @team:DataDog/synthetics-ct
Scenario: Trigger Synthetic tests returns "Bad Request" response
Given new "TriggerTests" request
Expand Down
6 changes: 6 additions & 0 deletions features/v1/undo.json
Original file line number Diff line number Diff line change
Expand Up @@ -1227,6 +1227,12 @@
"type": "idempotent"
}
},
"SearchTests": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"TriggerTests": {
"tag": "Synthetics",
"undo": {
Expand Down
Loading
Loading