RubyGems - datadog_api_client - Versions diffs - 1.1.0 → 1.5.0 - Mend

datadog_api_client 1.1.0 → 1.5.0

Files changed (2295) hide show

data/docs/v1/SyntheticsAPI.md CHANGED Viewed

@@ -2,41 +2,40 @@
 All URIs are relative to *https://api.datadoghq.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_global_variable**](SyntheticsAPI.md#create_global_variable) | **POST** /api/v1/synthetics/variables | Create a global variable |
-| [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location |
-| [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test |
-| [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test |
-| [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable |
-| [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location |
-| [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests |
-| [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable |
-| [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test |
-| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test&#39;s latest results summaries |
-| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result |
-| [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test |
-| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test&#39;s latest results summaries |
-| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result |
-| [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable |
-| [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location |
-| [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration |
-| [**list_global_variables**](SyntheticsAPI.md#list_global_variables) | **GET** /api/v1/synthetics/variables | Get all global variables |
-| [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) |
-| [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests |
-| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines |
-| [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test |
-| [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test |
-| [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location |
-| [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test |
+| Method                                                                                  | HTTP request                                                             | Description                                       |
+| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------- |
+| [**create_global_variable**](SyntheticsAPI.md#create_global_variable)                   | **POST** /api/v1/synthetics/variables                                    | Create a global variable                          |
+| [**create_private_location**](SyntheticsAPI.md#create_private_location)                 | **POST** /api/v1/synthetics/private-locations                            | Create a private location                         |
+| [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test)           | **POST** /api/v1/synthetics/tests/api                                    | Create an API test                                |
+| [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test)   | **POST** /api/v1/synthetics/tests/browser                                | Create a browser test                             |
+| [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable)                   | **DELETE** /api/v1/synthetics/variables/{variable_id}                    | Delete a global variable                          |
+| [**delete_private_location**](SyntheticsAPI.md#delete_private_location)                 | **DELETE** /api/v1/synthetics/private-locations/{location_id}            | Delete a private location                         |
+| [**delete_tests**](SyntheticsAPI.md#delete_tests)                                       | **POST** /api/v1/synthetics/tests/delete                                 | Delete tests                                      |
+| [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable)                       | **PUT** /api/v1/synthetics/variables/{variable_id}                       | Edit a global variable                            |
+| [**get_api_test**](SyntheticsAPI.md#get_api_test)                                       | **GET** /api/v1/synthetics/tests/api/{public_id}                         | Get an API test                                   |
+| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results)         | **GET** /api/v1/synthetics/tests/{public_id}/results                     | Get an API test&#39;s latest results summaries    |
+| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result)                         | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id}         | Get an API test result                            |
+| [**get_browser_test**](SyntheticsAPI.md#get_browser_test)                               | **GET** /api/v1/synthetics/tests/browser/{public_id}                     | Get a browser test                                |
+| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results             | Get a browser test&#39;s latest results summaries |
+| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result)                 | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result                         |
+| [**get_global_variable**](SyntheticsAPI.md#get_global_variable)                         | **GET** /api/v1/synthetics/variables/{variable_id}                       | Get a global variable                             |
+| [**get_private_location**](SyntheticsAPI.md#get_private_location)                       | **GET** /api/v1/synthetics/private-locations/{location_id}               | Get a private location                            |
+| [**get_synthetics_ci_batch**](SyntheticsAPI.md#get_synthetics_ci_batch)                 | **GET** /api/v1/synthetics/ci/batch/{batch_id}                           | Get details of batch                              |
+| [**get_test**](SyntheticsAPI.md#get_test)                                               | **GET** /api/v1/synthetics/tests/{public_id}                             | Get a test configuration                          |
+| [**list_global_variables**](SyntheticsAPI.md#list_global_variables)                     | **GET** /api/v1/synthetics/variables                                     | Get all global variables                          |
+| [**list_locations**](SyntheticsAPI.md#list_locations)                                   | **GET** /api/v1/synthetics/locations                                     | Get all locations (public and private)            |
+| [**list_tests**](SyntheticsAPI.md#list_tests)                                           | **GET** /api/v1/synthetics/tests                                         | Get the list of all tests                         |
+| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests)                               | **POST** /api/v1/synthetics/tests/trigger/ci                             | Trigger tests from CI/CD pipelines                |
+| [**trigger_tests**](SyntheticsAPI.md#trigger_tests)                                     | **POST** /api/v1/synthetics/tests/trigger                                | Trigger Synthetics tests                          |
+| [**update_api_test**](SyntheticsAPI.md#update_api_test)                                 | **PUT** /api/v1/synthetics/tests/api/{public_id}                         | Edit an API test                                  |
+| [**update_browser_test**](SyntheticsAPI.md#update_browser_test)                         | **PUT** /api/v1/synthetics/tests/browser/{public_id}                     | Edit a browser test                               |
+| [**update_private_location**](SyntheticsAPI.md#update_private_location)                 | **PUT** /api/v1/synthetics/private-locations/{location_id}               | Edit a private location                           |
+| [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status)               | **PUT** /api/v1/synthetics/tests/{public_id}/status                      | Pause or start a test                             |
 ## create_global_variable
 > <SyntheticsGlobalVariable> create_global_variable(body)
-Create a global variable
 Create a Synthetics global variable.
 ### Examples
@@ -75,9 +74,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to create. |  |
+| Name     | Type                                                        | Description                               | Notes |
+| -------- | ----------------------------------------------------------- | ----------------------------------------- | ----- |
+| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to create. |       |
 ### Return type
@@ -92,13 +91,10 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## create_private_location
 > <SyntheticsPrivateLocationCreationResponse> create_private_location(body)
-Create a private location
 Create a new Synthetics private location.
 ### Examples
@@ -137,9 +133,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to create. |  |
+| Name     | Type                                                          | Description                                | Notes |
+| -------- | ------------------------------------------------------------- | ------------------------------------------ | ----- |
+| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to create. |       |
 ### Return type
@@ -154,13 +150,10 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## create_synthetics_api_test
 > <SyntheticsAPITest> create_synthetics_api_test(body)
-Create an API test
 Create a Synthetic API test.
 ### Examples
@@ -199,9 +192,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | Details of the test to create. |  |
+| Name     | Type                                          | Description                    | Notes |
+| -------- | --------------------------------------------- | ------------------------------ | ----- |
+| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | Details of the test to create. |       |
 ### Return type
@@ -209,20 +202,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## create_synthetics_browser_test
 > <SyntheticsBrowserTest> create_synthetics_browser_test(body)
-Create a browser test
 Create a Synthetic browser test.
 ### Examples
@@ -261,9 +251,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | Details of the test to create. |  |
+| Name     | Type                                                  | Description                    | Notes |
+| -------- | ----------------------------------------------------- | ------------------------------ | ----- |
+| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | Details of the test to create. |       |
 ### Return type
@@ -271,20 +261,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## delete_global_variable
 > delete_global_variable(variable_id)
-Delete a global variable
 Delete a Synthetics global variable.
 ### Examples
@@ -322,9 +309,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **variable_id** | **String** | The ID of the global variable. |  |
+| Name            | Type       | Description                    | Notes |
+| --------------- | ---------- | ------------------------------ | ----- |
+| **variable_id** | **String** | The ID of the global variable. |       |
 ### Return type
@@ -332,20 +319,17 @@ nil (empty response body)
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## delete_private_location
 > delete_private_location(location_id)
-Delete a private location
 Delete a Synthetics private location.
 ### Examples
@@ -383,9 +367,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **location_id** | **String** | The ID of the private location. |  |
+| Name            | Type       | Description                     | Notes |
+| --------------- | ---------- | ------------------------------- | ----- |
+| **location_id** | **String** | The ID of the private location. |       |
 ### Return type
@@ -400,13 +384,10 @@ nil (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## delete_tests
 > <SyntheticsDeleteTestsResponse> delete_tests(body)
-Delete tests
 Delete multiple Synthetic tests by ID.
 ### Examples
@@ -445,9 +426,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsDeleteTestsPayload**](SyntheticsDeleteTestsPayload.md) | Public ID list of the Synthetic tests to be deleted. |  |
+| Name     | Type                                                                | Description                                          | Notes |
+| -------- | ------------------------------------------------------------------- | ---------------------------------------------------- | ----- |
+| **body** | [**SyntheticsDeleteTestsPayload**](SyntheticsDeleteTestsPayload.md) | Public ID list of the Synthetic tests to be deleted. |       |
 ### Return type
@@ -455,20 +436,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## edit_global_variable
 > <SyntheticsGlobalVariable> edit_global_variable(variable_id, body)
-Edit a global variable
 Edit a Synthetics global variable.
 ### Examples
@@ -508,10 +486,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **variable_id** | **String** | The ID of the global variable. |  |
-| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to update. |  |
+| Name            | Type                                                        | Description                               | Notes |
+| --------------- | ----------------------------------------------------------- | ----------------------------------------- | ----- |
+| **variable_id** | **String**                                                  | The ID of the global variable.            |       |
+| **body**        | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to update. |       |
 ### Return type
@@ -526,14 +504,12 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## get_api_test
 > <SyntheticsAPITest> get_api_test(public_id)
-Get an API test
-Get the detailed configuration associated with a Synthetic API test.
+Get the detailed configuration associated with
+a Synthetic API test.
 ### Examples
@@ -571,9 +547,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
+| Name          | Type       | Description                                    | Notes |
+| ------------- | ---------- | ---------------------------------------------- | ----- |
+| **public_id** | **String** | The public ID of the test to get details from. |       |
 ### Return type
@@ -581,20 +557,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_api_test_latest_results
 > <SyntheticsGetAPITestLatestResultsResponse> get_api_test_latest_results(public_id, opts)
-Get an API test's latest results summaries
 Get the last 50 test results summaries for a given Synthetics API test.
 ### Examples
@@ -604,8 +577,8 @@ require 'datadog_api_client'
 api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 public_id = 'public_id_example' # String | The public ID of the test for which to search results for.
 opts = {
-  from_ts: 789, # Integer | Timestamp from which to start querying results.
-  to_ts: 789, # Integer | Timestamp up to which to query results.
+  from_ts: 789, # Integer | Timestamp in milliseconds from which to start querying results.
+  to_ts: 789, # Integer | Timestamp in milliseconds up to which to query results.
   probe_dc: ['inner_example'] # Array<String> | Locations for which to query results.
 }
@@ -638,12 +611,12 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test for which to search results for. |  |
-| **from_ts** | **Integer** | Timestamp from which to start querying results. | [optional] |
-| **to_ts** | **Integer** | Timestamp up to which to query results. | [optional] |
-| **probe_dc** | **Array&lt;String&gt;** | Locations for which to query results. | [optional] |
+| Name          | Type                    | Description                                                     | Notes      |
+| ------------- | ----------------------- | --------------------------------------------------------------- | ---------- |
+| **public_id** | **String**              | The public ID of the test for which to search results for.      |            |
+| **from_ts**   | **Integer**             | Timestamp in milliseconds from which to start querying results. | [optional] |
+| **to_ts**     | **Integer**             | Timestamp in milliseconds up to which to query results.         | [optional] |
+| **probe_dc**  | **Array&lt;String&gt;** | Locations for which to query results.                           | [optional] |
 ### Return type
@@ -651,20 +624,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_api_test_result
 > <SyntheticsAPITestResultFull> get_api_test_result(public_id, result_id)
-Get an API test result
 Get a specific full result from a given (API) Synthetic test.
 ### Examples
@@ -704,10 +674,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the API test to which the target result belongs. |  |
-| **result_id** | **String** | The ID of the result to get. |  |
+| Name          | Type       | Description                                                       | Notes |
+| ------------- | ---------- | ----------------------------------------------------------------- | ----- |
+| **public_id** | **String** | The public ID of the API test to which the target result belongs. |       |
+| **result_id** | **String** | The ID of the result to get.                                      |       |
 ### Return type
@@ -715,21 +685,19 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_browser_test
 > <SyntheticsBrowserTest> get_browser_test(public_id)
-Get a browser test
-Get the detailed configuration (including steps) associated with a Synthetic browser test.
+Get the detailed configuration (including steps) associated with
+a Synthetic browser test.
 ### Examples
@@ -767,9 +735,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
+| Name          | Type       | Description                                    | Notes |
+| ------------- | ---------- | ---------------------------------------------- | ----- |
+| **public_id** | **String** | The public ID of the test to get details from. |       |
 ### Return type
@@ -777,20 +745,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_browser_test_latest_results
 > <SyntheticsGetBrowserTestLatestResultsResponse> get_browser_test_latest_results(public_id, opts)
-Get a browser test's latest results summaries
 Get the last 50 test results summaries for a given Synthetics Browser test.
 ### Examples
@@ -800,8 +765,8 @@ require 'datadog_api_client'
 api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
 public_id = 'public_id_example' # String | The public ID of the browser test for which to search results for.
 opts = {
-  from_ts: 789, # Integer | Timestamp from which to start querying results.
-  to_ts: 789, # Integer | Timestamp up to which to query results.
+  from_ts: 789, # Integer | Timestamp in milliseconds from which to start querying results.
+  to_ts: 789, # Integer | Timestamp in milliseconds up to which to query results.
   probe_dc: ['inner_example'] # Array<String> | Locations for which to query results.
 }
@@ -834,12 +799,12 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the browser test for which to search results for. |  |
-| **from_ts** | **Integer** | Timestamp from which to start querying results. | [optional] |
-| **to_ts** | **Integer** | Timestamp up to which to query results. | [optional] |
-| **probe_dc** | **Array&lt;String&gt;** | Locations for which to query results. | [optional] |
+| Name          | Type                    | Description                                                        | Notes      |
+| ------------- | ----------------------- | ------------------------------------------------------------------ | ---------- |
+| **public_id** | **String**              | The public ID of the browser test for which to search results for. |            |
+| **from_ts**   | **Integer**             | Timestamp in milliseconds from which to start querying results.    | [optional] |
+| **to_ts**     | **Integer**             | Timestamp in milliseconds up to which to query results.            | [optional] |
+| **probe_dc**  | **Array&lt;String&gt;** | Locations for which to query results.                              | [optional] |
 ### Return type
@@ -847,20 +812,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_browser_test_result
 > <SyntheticsBrowserTestResultFull> get_browser_test_result(public_id, result_id)
-Get a browser test result
 Get a specific full result from a given (browser) Synthetic test.
 ### Examples
@@ -900,10 +862,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the browser test to which the target result belongs. |  |
-| **result_id** | **String** | The ID of the result to get. |  |
+| Name          | Type       | Description                                                           | Notes |
+| ------------- | ---------- | --------------------------------------------------------------------- | ----- |
+| **public_id** | **String** | The public ID of the browser test to which the target result belongs. |       |
+| **result_id** | **String** | The ID of the result to get.                                          |       |
 ### Return type
@@ -911,20 +873,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_global_variable
 > <SyntheticsGlobalVariable> get_global_variable(variable_id)
-Get a global variable
 Get the detailed configuration of a global variable.
 ### Examples
@@ -963,9 +922,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **variable_id** | **String** | The ID of the global variable. |  |
+| Name            | Type       | Description                    | Notes |
+| --------------- | ---------- | ------------------------------ | ----- |
+| **variable_id** | **String** | The ID of the global variable. |       |
 ### Return type
@@ -973,20 +932,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## get_private_location
 > <SyntheticsPrivateLocation> get_private_location(location_id)
-Get a private location
 Get a Synthetics private location.
 ### Examples
@@ -1025,9 +981,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **location_id** | **String** | The ID of the private location. |  |
+| Name            | Type       | Description                     | Notes |
+| --------------- | ---------- | ------------------------------- | ----- |
+| **location_id** | **String** | The ID of the private location. |       |
 ### Return type
@@ -1042,13 +998,69 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
+## get_synthetics_ci_batch
+> <SyntheticsBatchDetails> get_synthetics_ci_batch(batch_id)
+Get a batch's updated details.
+### Examples
+```ruby
+require 'datadog_api_client'
+api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
+batch_id = 'batch_id_example' # String | The ID of the batch.
+begin
+  # Get details of batch
+  result = api_instance.get_synthetics_ci_batch(batch_id)
+  p result
+rescue DatadogAPIClient::V1::APIError => e
+  puts "Error when calling SyntheticsAPI->get_synthetics_ci_batch: #{e}"
+end
+```
+#### Using the get_synthetics_ci_batch_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<SyntheticsBatchDetails>, Integer, Hash)> get_synthetics_ci_batch_with_http_info(batch_id)
+```ruby
+begin
+  # Get details of batch
+  data, status_code, headers = api_instance.get_synthetics_ci_batch_with_http_info(batch_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SyntheticsBatchDetails>
+rescue DatadogAPIClient::V1::APIError => e
+  puts "Error when calling SyntheticsAPI->get_synthetics_ci_batch_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name         | Type       | Description          | Notes |
+| ------------ | ---------- | -------------------- | ----- |
+| **batch_id** | **String** | The ID of the batch. |       |
+### Return type
+[**SyntheticsBatchDetails**](SyntheticsBatchDetails.md)
+### Authorization
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+### HTTP request headers
+- **Content-Type**: Not defined
+- **Accept**: application/json
 ## get_test
 > <SyntheticsTestDetails> get_test(public_id)
-Get a test configuration
 Get the detailed configuration associated with a Synthetics test.
 ### Examples
@@ -1087,9 +1099,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
+| Name          | Type       | Description                                    | Notes |
+| ------------- | ---------- | ---------------------------------------------- | ----- |
+| **public_id** | **String** | The public ID of the test to get details from. |       |
 ### Return type
@@ -1104,13 +1116,10 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## list_global_variables
 > <SyntheticsListGlobalVariablesResponse> list_global_variables
-Get all global variables
 Get the list of all Synthetics global variables.
 ### Examples
@@ -1156,21 +1165,19 @@ This endpoint does not need any parameter.
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## list_locations
 > <SyntheticsLocations> list_locations
-Get all locations (public and private)
-Get the list of public and private locations available for Synthetic tests. No arguments required.
+Get the list of public and private locations available for Synthetic
+tests. No arguments required.
 ### Examples
@@ -1215,20 +1222,17 @@ This endpoint does not need any parameter.
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## list_tests
 > <SyntheticsListTestsResponse> list_tests
-Get the list of all tests
 Get the list of all Synthetic tests.
 ### Examples
@@ -1274,20 +1278,17 @@ This endpoint does not need any parameter.
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: Not defined
 - **Accept**: application/json
 ## trigger_ci_tests
 > <SyntheticsTriggerCITestsResponse> trigger_ci_tests(body)
-Trigger tests from CI/CD pipelines
 Trigger a set of Synthetics tests for continuous integration.
 ### Examples
@@ -1326,9 +1327,9 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**SyntheticsCITestBody**](SyntheticsCITestBody.md) | Details of the test to trigger. |  |
+| Name     | Type                                                | Description                     | Notes |
+| -------- | --------------------------------------------------- | ------------------------------- | ----- |
+| **body** | [**SyntheticsCITestBody**](SyntheticsCITestBody.md) | Details of the test to trigger. |       |
 ### Return type
@@ -1343,13 +1344,69 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
+## trigger_tests
+> <SyntheticsTriggerCITestsResponse> trigger_tests(body)
+Trigger a set of Synthetics tests.
+### Examples
+```ruby
+require 'datadog_api_client'
+api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
+body = DatadogAPIClient::V1::SyntheticsTriggerBody.new({tests: [DatadogAPIClient::V1::SyntheticsTriggerTest.new({public_id: 'aaa-aaa-aaa'})]}) # SyntheticsTriggerBody | The identifiers of the tests to trigger.
+begin
+  # Trigger Synthetics tests
+  result = api_instance.trigger_tests(body)
+  p result
+rescue DatadogAPIClient::V1::APIError => e
+  puts "Error when calling SyntheticsAPI->trigger_tests: #{e}"
+end
+```
+#### Using the trigger_tests_with_http_info variant
+This returns an Array which contains the response data, status code and headers.
+> <Array(<SyntheticsTriggerCITestsResponse>, Integer, Hash)> trigger_tests_with_http_info(body)
+```ruby
+begin
+  # Trigger Synthetics tests
+  data, status_code, headers = api_instance.trigger_tests_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SyntheticsTriggerCITestsResponse>
+rescue DatadogAPIClient::V1::APIError => e
+  puts "Error when calling SyntheticsAPI->trigger_tests_with_http_info: #{e}"
+end
+```
+### Parameters
+| Name     | Type                                                  | Description                              | Notes |
+| -------- | ----------------------------------------------------- | ---------------------------------------- | ----- |
+| **body** | [**SyntheticsTriggerBody**](SyntheticsTriggerBody.md) | The identifiers of the tests to trigger. |       |
+### Return type
+[**SyntheticsTriggerCITestsResponse**](SyntheticsTriggerCITestsResponse.md)
+### Authorization
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+### HTTP request headers
+- **Content-Type**: application/json
+- **Accept**: application/json
 ## update_api_test
 > <SyntheticsAPITest> update_api_test(public_id, body)
-Edit an API test
 Edit the configuration of a Synthetic API test.
 ### Examples
@@ -1389,10 +1446,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
-| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | New test details to be saved. |  |
+| Name          | Type                                          | Description                                    | Notes |
+| ------------- | --------------------------------------------- | ---------------------------------------------- | ----- |
+| **public_id** | **String**                                    | The public ID of the test to get details from. |       |
+| **body**      | [**SyntheticsAPITest**](SyntheticsAPITest.md) | New test details to be saved.                  |       |
 ### Return type
@@ -1400,20 +1457,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## update_browser_test
 > <SyntheticsBrowserTest> update_browser_test(public_id, body)
-Edit a browser test
 Edit the configuration of a Synthetic browser test.
 ### Examples
@@ -1453,10 +1507,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the test to get details from. |  |
-| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | New test details to be saved. |  |
+| Name          | Type                                                  | Description                                    | Notes |
+| ------------- | ----------------------------------------------------- | ---------------------------------------------- | ----- |
+| **public_id** | **String**                                            | The public ID of the test to get details from. |       |
+| **body**      | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | New test details to be saved.                  |       |
 ### Return type
@@ -1464,20 +1518,17 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## update_private_location
 > <SyntheticsPrivateLocation> update_private_location(location_id, body)
-Edit a private location
 Edit a Synthetics private location.
 ### Examples
@@ -1517,10 +1568,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **location_id** | **String** | The ID of the private location. |  |
-| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to be updated. |  |
+| Name            | Type                                                          | Description                                    | Notes |
+| --------------- | ------------------------------------------------------------- | ---------------------------------------------- | ----- |
+| **location_id** | **String**                                                    | The ID of the private location.                |       |
+| **body**        | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to be updated. |       |
 ### Return type
@@ -1535,13 +1586,10 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 ## update_test_pause_status
 > Boolean update_test_pause_status(public_id, body)
-Pause or start a test
 Pause or start a Synthetics test by changing the status.
 ### Examples
@@ -1581,10 +1629,10 @@ end
 ### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **public_id** | **String** | The public ID of the Synthetic test to update. |  |
-| **body** | [**SyntheticsUpdateTestPauseStatusPayload**](SyntheticsUpdateTestPauseStatusPayload.md) | Status to set the given Synthetic test to. |  |
+| Name          | Type                                                                                    | Description                                    | Notes |
+| ------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- | ----- |
+| **public_id** | **String**                                                                              | The public ID of the Synthetic test to update. |       |
+| **body**      | [**SyntheticsUpdateTestPauseStatusPayload**](SyntheticsUpdateTestPauseStatusPayload.md) | Status to set the given Synthetic test to.     |       |
 ### Return type
@@ -1592,10 +1640,9 @@ end
 ### Authorization
-[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+[AuthZ](README.md#AuthZ), [apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
 ### HTTP request headers
 - **Content-Type**: application/json
 - **Accept**: application/json