com.datadog.api.client.v1.api

Class SyntheticsApi

java.lang.Object

com.datadog.api.client.v1.api.SyntheticsApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SyntheticsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyntheticsApi.GetAPITestLatestResultsOptionalParameters Manage optional parameters to getAPITestLatestResults.
static class	SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters Manage optional parameters to getBrowserTestLatestResults.
static class	SyntheticsApi.ListTestsOptionalParameters Manage optional parameters to listTests.

Constructor Summary

Constructors

Constructor and Description
SyntheticsApi()
SyntheticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SyntheticsGlobalVariable	createGlobalVariable(SyntheticsGlobalVariable body) Create a global variable.
CompletableFuture<SyntheticsGlobalVariable>	createGlobalVariableAsync(SyntheticsGlobalVariable body) Create a global variable.
ApiResponse<SyntheticsGlobalVariable>	createGlobalVariableWithHttpInfo(SyntheticsGlobalVariable body) Create a Synthetic global variable.
CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>	createGlobalVariableWithHttpInfoAsync(SyntheticsGlobalVariable body) Create a global variable.
SyntheticsPrivateLocationCreationResponse	createPrivateLocation(SyntheticsPrivateLocation body) Create a private location.
CompletableFuture<SyntheticsPrivateLocationCreationResponse>	createPrivateLocationAsync(SyntheticsPrivateLocation body) Create a private location.
ApiResponse<SyntheticsPrivateLocationCreationResponse>	createPrivateLocationWithHttpInfo(SyntheticsPrivateLocation body) Create a new Synthetic private location.
CompletableFuture<ApiResponse<SyntheticsPrivateLocationCreationResponse>>	createPrivateLocationWithHttpInfoAsync(SyntheticsPrivateLocation body) Create a private location.
SyntheticsAPITest	createSyntheticsAPITest(SyntheticsAPITest body) Create an API test.
CompletableFuture<SyntheticsAPITest>	createSyntheticsAPITestAsync(SyntheticsAPITest body) Create an API test.
ApiResponse<SyntheticsAPITest>	createSyntheticsAPITestWithHttpInfo(SyntheticsAPITest body) Create a Synthetic API test.
CompletableFuture<ApiResponse<SyntheticsAPITest>>	createSyntheticsAPITestWithHttpInfoAsync(SyntheticsAPITest body) Create an API test.
SyntheticsBrowserTest	createSyntheticsBrowserTest(SyntheticsBrowserTest body) Create a browser test.
CompletableFuture<SyntheticsBrowserTest>	createSyntheticsBrowserTestAsync(SyntheticsBrowserTest body) Create a browser test.
ApiResponse<SyntheticsBrowserTest>	createSyntheticsBrowserTestWithHttpInfo(SyntheticsBrowserTest body) Create a Synthetic browser test.
CompletableFuture<ApiResponse<SyntheticsBrowserTest>>	createSyntheticsBrowserTestWithHttpInfoAsync(SyntheticsBrowserTest body) Create a browser test.
void	deleteGlobalVariable(String variableId) Delete a global variable.
CompletableFuture<Void>	deleteGlobalVariableAsync(String variableId) Delete a global variable.
ApiResponse<Void>	deleteGlobalVariableWithHttpInfo(String variableId) Delete a Synthetic global variable.
CompletableFuture<ApiResponse<Void>>	deleteGlobalVariableWithHttpInfoAsync(String variableId) Delete a global variable.
void	deletePrivateLocation(String locationId) Delete a private location.
CompletableFuture<Void>	deletePrivateLocationAsync(String locationId) Delete a private location.
ApiResponse<Void>	deletePrivateLocationWithHttpInfo(String locationId) Delete a Synthetic private location.
CompletableFuture<ApiResponse<Void>>	deletePrivateLocationWithHttpInfoAsync(String locationId) Delete a private location.
SyntheticsDeleteTestsResponse	deleteTests(SyntheticsDeleteTestsPayload body) Delete tests.
CompletableFuture<SyntheticsDeleteTestsResponse>	deleteTestsAsync(SyntheticsDeleteTestsPayload body) Delete tests.
ApiResponse<SyntheticsDeleteTestsResponse>	deleteTestsWithHttpInfo(SyntheticsDeleteTestsPayload body) Delete multiple Synthetic tests by ID.
CompletableFuture<ApiResponse<SyntheticsDeleteTestsResponse>>	deleteTestsWithHttpInfoAsync(SyntheticsDeleteTestsPayload body) Delete tests.
SyntheticsGlobalVariable	editGlobalVariable(String variableId, SyntheticsGlobalVariable body) Edit a global variable.
CompletableFuture<SyntheticsGlobalVariable>	editGlobalVariableAsync(String variableId, SyntheticsGlobalVariable body) Edit a global variable.
ApiResponse<SyntheticsGlobalVariable>	editGlobalVariableWithHttpInfo(String variableId, SyntheticsGlobalVariable body) Edit a Synthetic global variable.
CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>	editGlobalVariableWithHttpInfoAsync(String variableId, SyntheticsGlobalVariable body) Edit a global variable.
ApiClient	getApiClient() Get the API client.
SyntheticsAPITest	getAPITest(String publicId) Get an API test.
CompletableFuture<SyntheticsAPITest>	getAPITestAsync(String publicId) Get an API test.
SyntheticsGetAPITestLatestResultsResponse	getAPITestLatestResults(String publicId) Get an API test's latest results summaries.
SyntheticsGetAPITestLatestResultsResponse	getAPITestLatestResults(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.
CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>	getAPITestLatestResultsAsync(String publicId) Get an API test's latest results summaries.
CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>	getAPITestLatestResultsAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.
ApiResponse<SyntheticsGetAPITestLatestResultsResponse>	getAPITestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get the last 150 test results summaries for a given Synthetic API test.
CompletableFuture<ApiResponse<SyntheticsGetAPITestLatestResultsResponse>>	getAPITestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.
SyntheticsAPITestResultFull	getAPITestResult(String publicId, String resultId) Get an API test result.
CompletableFuture<SyntheticsAPITestResultFull>	getAPITestResultAsync(String publicId, String resultId) Get an API test result.
ApiResponse<SyntheticsAPITestResultFull>	getAPITestResultWithHttpInfo(String publicId, String resultId) Get a specific full result from a given Synthetic API test.
CompletableFuture<ApiResponse<SyntheticsAPITestResultFull>>	getAPITestResultWithHttpInfoAsync(String publicId, String resultId) Get an API test result.
ApiResponse<SyntheticsAPITest>	getAPITestWithHttpInfo(String publicId) Get the detailed configuration associated with a Synthetic API test.
CompletableFuture<ApiResponse<SyntheticsAPITest>>	getAPITestWithHttpInfoAsync(String publicId) Get an API test.
SyntheticsBrowserTest	getBrowserTest(String publicId) Get a browser test.
CompletableFuture<SyntheticsBrowserTest>	getBrowserTestAsync(String publicId) Get a browser test.
SyntheticsGetBrowserTestLatestResultsResponse	getBrowserTestLatestResults(String publicId) Get a browser test's latest results summaries.
SyntheticsGetBrowserTestLatestResultsResponse	getBrowserTestLatestResults(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.
CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>	getBrowserTestLatestResultsAsync(String publicId) Get a browser test's latest results summaries.
CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>	getBrowserTestLatestResultsAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.
ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>	getBrowserTestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get the last 150 test results summaries for a given Synthetic browser test.
CompletableFuture<ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>>	getBrowserTestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.
SyntheticsBrowserTestResultFull	getBrowserTestResult(String publicId, String resultId) Get a browser test result.
CompletableFuture<SyntheticsBrowserTestResultFull>	getBrowserTestResultAsync(String publicId, String resultId) Get a browser test result.
ApiResponse<SyntheticsBrowserTestResultFull>	getBrowserTestResultWithHttpInfo(String publicId, String resultId) Get a specific full result from a given Synthetic browser test.
CompletableFuture<ApiResponse<SyntheticsBrowserTestResultFull>>	getBrowserTestResultWithHttpInfoAsync(String publicId, String resultId) Get a browser test result.
ApiResponse<SyntheticsBrowserTest>	getBrowserTestWithHttpInfo(String publicId) Get the detailed configuration (including steps) associated with a Synthetic browser test.
CompletableFuture<ApiResponse<SyntheticsBrowserTest>>	getBrowserTestWithHttpInfoAsync(String publicId) Get a browser test.
SyntheticsGlobalVariable	getGlobalVariable(String variableId) Get a global variable.
CompletableFuture<SyntheticsGlobalVariable>	getGlobalVariableAsync(String variableId) Get a global variable.
ApiResponse<SyntheticsGlobalVariable>	getGlobalVariableWithHttpInfo(String variableId) Get the detailed configuration of a global variable.
CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>	getGlobalVariableWithHttpInfoAsync(String variableId) Get a global variable.
SyntheticsPrivateLocation	getPrivateLocation(String locationId) Get a private location.
CompletableFuture<SyntheticsPrivateLocation>	getPrivateLocationAsync(String locationId) Get a private location.
ApiResponse<SyntheticsPrivateLocation>	getPrivateLocationWithHttpInfo(String locationId) Get a Synthetic private location.
CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>	getPrivateLocationWithHttpInfoAsync(String locationId) Get a private location.
SyntheticsBatchDetails	getSyntheticsCIBatch(String batchId) Get details of batch.
CompletableFuture<SyntheticsBatchDetails>	getSyntheticsCIBatchAsync(String batchId) Get details of batch.
ApiResponse<SyntheticsBatchDetails>	getSyntheticsCIBatchWithHttpInfo(String batchId) Get a batch's updated details.
CompletableFuture<ApiResponse<SyntheticsBatchDetails>>	getSyntheticsCIBatchWithHttpInfoAsync(String batchId) Get details of batch.
List<String>	getSyntheticsDefaultLocations() Get the default locations.
CompletableFuture<List<String>>	getSyntheticsDefaultLocationsAsync() Get the default locations.
ApiResponse<List<String>>	getSyntheticsDefaultLocationsWithHttpInfo() Get the default locations settings.
CompletableFuture<ApiResponse<List<String>>>	getSyntheticsDefaultLocationsWithHttpInfoAsync() Get the default locations.
SyntheticsTestDetails	getTest(String publicId) Get a test configuration.
CompletableFuture<SyntheticsTestDetails>	getTestAsync(String publicId) Get a test configuration.
ApiResponse<SyntheticsTestDetails>	getTestWithHttpInfo(String publicId) Get the detailed configuration associated with a Synthetic test.
CompletableFuture<ApiResponse<SyntheticsTestDetails>>	getTestWithHttpInfoAsync(String publicId) Get a test configuration.
SyntheticsListGlobalVariablesResponse	listGlobalVariables() Get all global variables.
CompletableFuture<SyntheticsListGlobalVariablesResponse>	listGlobalVariablesAsync() Get all global variables.
ApiResponse<SyntheticsListGlobalVariablesResponse>	listGlobalVariablesWithHttpInfo() Get the list of all Synthetic global variables.
CompletableFuture<ApiResponse<SyntheticsListGlobalVariablesResponse>>	listGlobalVariablesWithHttpInfoAsync() Get all global variables.
SyntheticsLocations	listLocations() Get all locations (public and private).
CompletableFuture<SyntheticsLocations>	listLocationsAsync() Get all locations (public and private).
ApiResponse<SyntheticsLocations>	listLocationsWithHttpInfo() Get the list of public and private locations available for Synthetic tests.
CompletableFuture<ApiResponse<SyntheticsLocations>>	listLocationsWithHttpInfoAsync() Get all locations (public and private).
SyntheticsListTestsResponse	listTests() Get the list of all Synthetic tests.
SyntheticsListTestsResponse	listTests(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.
CompletableFuture<SyntheticsListTestsResponse>	listTestsAsync() Get the list of all Synthetic tests.
CompletableFuture<SyntheticsListTestsResponse>	listTestsAsync(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.
ApiResponse<SyntheticsListTestsResponse>	listTestsWithHttpInfo(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.
CompletableFuture<ApiResponse<SyntheticsListTestsResponse>>	listTestsWithHttpInfoAsync(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.
PaginationIterable<SyntheticsTestDetails>	listTestsWithPagination() Get the list of all Synthetic tests.
PaginationIterable<SyntheticsTestDetails>	listTestsWithPagination(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.
SyntheticsTestDetails	patchTest(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.
CompletableFuture<SyntheticsTestDetails>	patchTestAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.
ApiResponse<SyntheticsTestDetails>	patchTestWithHttpInfo(String publicId, SyntheticsPatchTestBody body) Patch the configuration of a Synthetic test with partial data.
CompletableFuture<ApiResponse<SyntheticsTestDetails>>	patchTestWithHttpInfoAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.
void	setApiClient(ApiClient apiClient) Set the API client.
SyntheticsTriggerCITestsResponse	triggerCITests(SyntheticsCITestBody body) Trigger tests from CI/CD pipelines.
CompletableFuture<SyntheticsTriggerCITestsResponse>	triggerCITestsAsync(SyntheticsCITestBody body) Trigger tests from CI/CD pipelines.
ApiResponse<SyntheticsTriggerCITestsResponse>	triggerCITestsWithHttpInfo(SyntheticsCITestBody body) Trigger a set of Synthetic tests for continuous integration.
CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>	triggerCITestsWithHttpInfoAsync(SyntheticsCITestBody body) Trigger tests from CI/CD pipelines.
SyntheticsTriggerCITestsResponse	triggerTests(SyntheticsTriggerBody body) Trigger Synthetic tests.
CompletableFuture<SyntheticsTriggerCITestsResponse>	triggerTestsAsync(SyntheticsTriggerBody body) Trigger Synthetic tests.
ApiResponse<SyntheticsTriggerCITestsResponse>	triggerTestsWithHttpInfo(SyntheticsTriggerBody body) Trigger a set of Synthetic tests.
CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>	triggerTestsWithHttpInfoAsync(SyntheticsTriggerBody body) Trigger Synthetic tests.
SyntheticsAPITest	updateAPITest(String publicId, SyntheticsAPITest body) Edit an API test.
CompletableFuture<SyntheticsAPITest>	updateAPITestAsync(String publicId, SyntheticsAPITest body) Edit an API test.
ApiResponse<SyntheticsAPITest>	updateAPITestWithHttpInfo(String publicId, SyntheticsAPITest body) Edit the configuration of a Synthetic API test.
CompletableFuture<ApiResponse<SyntheticsAPITest>>	updateAPITestWithHttpInfoAsync(String publicId, SyntheticsAPITest body) Edit an API test.
SyntheticsBrowserTest	updateBrowserTest(String publicId, SyntheticsBrowserTest body) Edit a browser test.
CompletableFuture<SyntheticsBrowserTest>	updateBrowserTestAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.
ApiResponse<SyntheticsBrowserTest>	updateBrowserTestWithHttpInfo(String publicId, SyntheticsBrowserTest body) Edit the configuration of a Synthetic browser test.
CompletableFuture<ApiResponse<SyntheticsBrowserTest>>	updateBrowserTestWithHttpInfoAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.
SyntheticsPrivateLocation	updatePrivateLocation(String locationId, SyntheticsPrivateLocation body) Edit a private location.
CompletableFuture<SyntheticsPrivateLocation>	updatePrivateLocationAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.
ApiResponse<SyntheticsPrivateLocation>	updatePrivateLocationWithHttpInfo(String locationId, SyntheticsPrivateLocation body) Edit a Synthetic private location.
CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>	updatePrivateLocationWithHttpInfoAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.
Boolean	updateTestPauseStatus(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.
CompletableFuture<Boolean>	updateTestPauseStatusAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.
ApiResponse<Boolean>	updateTestPauseStatusWithHttpInfo(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a Synthetic test by changing the status.
CompletableFuture<ApiResponse<Boolean>>	updateTestPauseStatusWithHttpInfoAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyntheticsApi

public SyntheticsApi()

SyntheticsApi

public SyntheticsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createGlobalVariable

public SyntheticsGlobalVariable createGlobalVariable(SyntheticsGlobalVariable body)
                                              throws ApiException

Create a global variable.

See createGlobalVariableWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

body - Details of the global variable to create. (required)

Returns:

SyntheticsGlobalVariable

Throws:

ApiException - if fails to make API call

createGlobalVariableAsync

public CompletableFuture<SyntheticsGlobalVariable> createGlobalVariableAsync(SyntheticsGlobalVariable body)

Create a global variable.

See createGlobalVariableWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

body - Details of the global variable to create. (required)

Returns:

CompletableFuture<SyntheticsGlobalVariable>

createGlobalVariableWithHttpInfo

public ApiResponse<SyntheticsGlobalVariable> createGlobalVariableWithHttpInfo(SyntheticsGlobalVariable body)
                                                                       throws ApiException

Create a Synthetic global variable.

Parameters:

body - Details of the global variable to create. (required)

Returns:

ApiResponse<SyntheticsGlobalVariable>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid request	-
403	Forbidden	-
409	Conflict	-
429	Too many requests	-

createGlobalVariableWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> createGlobalVariableWithHttpInfoAsync(SyntheticsGlobalVariable body)

Create a global variable.

See createGlobalVariableWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

body - Details of the global variable to create. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>

createPrivateLocation

public SyntheticsPrivateLocationCreationResponse createPrivateLocation(SyntheticsPrivateLocation body)
                                                                throws ApiException

Create a private location.

See createPrivateLocationWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

body - Details of the private location to create. (required)

Returns:

SyntheticsPrivateLocationCreationResponse

Throws:

ApiException - if fails to make API call

createPrivateLocationAsync

public CompletableFuture<SyntheticsPrivateLocationCreationResponse> createPrivateLocationAsync(SyntheticsPrivateLocation body)

Create a private location.

See createPrivateLocationWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

body - Details of the private location to create. (required)

Returns:

CompletableFuture<SyntheticsPrivateLocationCreationResponse>

createPrivateLocationWithHttpInfo

public ApiResponse<SyntheticsPrivateLocationCreationResponse> createPrivateLocationWithHttpInfo(SyntheticsPrivateLocation body)
                                                                                         throws ApiException

Create a new Synthetic private location.

Parameters:

body - Details of the private location to create. (required)

Returns:

ApiResponse<SyntheticsPrivateLocationCreationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
402	Quota reached for private locations	-
404	Private locations are not activated for the user	-
429	Too many requests	-

createPrivateLocationWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsPrivateLocationCreationResponse>> createPrivateLocationWithHttpInfoAsync(SyntheticsPrivateLocation body)

Create a private location.

See createPrivateLocationWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

body - Details of the private location to create. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsPrivateLocationCreationResponse>>

createSyntheticsAPITest

public SyntheticsAPITest createSyntheticsAPITest(SyntheticsAPITest body)
                                          throws ApiException

Create an API test.

See createSyntheticsAPITestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

body - Details of the test to create. (required)

Returns:

SyntheticsAPITest

Throws:

ApiException - if fails to make API call

createSyntheticsAPITestAsync

public CompletableFuture<SyntheticsAPITest> createSyntheticsAPITestAsync(SyntheticsAPITest body)

Create an API test.

See createSyntheticsAPITestWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

body - Details of the test to create. (required)

Returns:

CompletableFuture<SyntheticsAPITest>

createSyntheticsAPITestWithHttpInfo

public ApiResponse<SyntheticsAPITest> createSyntheticsAPITestWithHttpInfo(SyntheticsAPITest body)
                                                                   throws ApiException

Create a Synthetic API test.

Parameters:

body - Details of the test to create. (required)

Returns:

ApiResponse<SyntheticsAPITest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK - Returns the created test details.	-
400	- JSON format is wrong - Creation failed	-
402	Test quota is reached	-
403	Forbidden	-
429	Too many requests	-

createSyntheticsAPITestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsAPITest>> createSyntheticsAPITestWithHttpInfoAsync(SyntheticsAPITest body)

Create an API test.

See createSyntheticsAPITestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

body - Details of the test to create. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsAPITest>>

createSyntheticsBrowserTest

public SyntheticsBrowserTest createSyntheticsBrowserTest(SyntheticsBrowserTest body)
                                                  throws ApiException

Create a browser test.

See createSyntheticsBrowserTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

body - Details of the test to create. (required)

Returns:

SyntheticsBrowserTest

Throws:

ApiException - if fails to make API call

createSyntheticsBrowserTestAsync

public CompletableFuture<SyntheticsBrowserTest> createSyntheticsBrowserTestAsync(SyntheticsBrowserTest body)

Create a browser test.

See createSyntheticsBrowserTestWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

body - Details of the test to create. (required)

Returns:

CompletableFuture<SyntheticsBrowserTest>

createSyntheticsBrowserTestWithHttpInfo

public ApiResponse<SyntheticsBrowserTest> createSyntheticsBrowserTestWithHttpInfo(SyntheticsBrowserTest body)
                                                                           throws ApiException

Create a Synthetic browser test.

Parameters:

body - Details of the test to create. (required)

Returns:

ApiResponse<SyntheticsBrowserTest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK - Returns the created test details.	-
400	- JSON format is wrong - Creation failed	-
402	Test quota is reached	-
403	Forbidden	-
429	Too many requests	-

createSyntheticsBrowserTestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> createSyntheticsBrowserTestWithHttpInfoAsync(SyntheticsBrowserTest body)

Create a browser test.

See createSyntheticsBrowserTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

body - Details of the test to create. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsBrowserTest>>

deleteGlobalVariable

public void deleteGlobalVariable(String variableId)
                          throws ApiException

Delete a global variable.

See deleteGlobalVariableWithHttpInfo(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Throws:

ApiException - if fails to make API call

deleteGlobalVariableAsync

public CompletableFuture<Void> deleteGlobalVariableAsync(String variableId)

Delete a global variable.

See deleteGlobalVariableWithHttpInfoAsync(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Returns:

CompletableFuture

deleteGlobalVariableWithHttpInfo

public ApiResponse<Void> deleteGlobalVariableWithHttpInfo(String variableId)
                                                   throws ApiException

Delete a Synthetic global variable.

Parameters:

variableId - The ID of the global variable. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	JSON format is wrong	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

deleteGlobalVariableWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteGlobalVariableWithHttpInfoAsync(String variableId)

Delete a global variable.

See deleteGlobalVariableWithHttpInfo(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deletePrivateLocation

public void deletePrivateLocation(String locationId)
                           throws ApiException

Delete a private location.

See deletePrivateLocationWithHttpInfo(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Throws:

ApiException - if fails to make API call

deletePrivateLocationAsync

public CompletableFuture<Void> deletePrivateLocationAsync(String locationId)

Delete a private location.

See deletePrivateLocationWithHttpInfoAsync(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Returns:

CompletableFuture

deletePrivateLocationWithHttpInfo

public ApiResponse<Void> deletePrivateLocationWithHttpInfo(String locationId)
                                                    throws ApiException

Delete a Synthetic private location.

Parameters:

locationId - The ID of the private location. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
404	- Private locations are not activated for the user - Private location does not exist	-
429	Too many requests	-

deletePrivateLocationWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deletePrivateLocationWithHttpInfoAsync(String locationId)

Delete a private location.

See deletePrivateLocationWithHttpInfo(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deleteTests

public SyntheticsDeleteTestsResponse deleteTests(SyntheticsDeleteTestsPayload body)
                                          throws ApiException

Delete tests.

See deleteTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).

Parameters:

body - Public ID list of the Synthetic tests to be deleted. (required)

Returns:

SyntheticsDeleteTestsResponse

Throws:

ApiException - if fails to make API call

deleteTestsAsync

public CompletableFuture<SyntheticsDeleteTestsResponse> deleteTestsAsync(SyntheticsDeleteTestsPayload body)

Delete tests.

See deleteTestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).

Parameters:

body - Public ID list of the Synthetic tests to be deleted. (required)

Returns:

CompletableFuture<SyntheticsDeleteTestsResponse>

deleteTestsWithHttpInfo

public ApiResponse<SyntheticsDeleteTestsResponse> deleteTestsWithHttpInfo(SyntheticsDeleteTestsPayload body)
                                                                   throws ApiException

Delete multiple Synthetic tests by ID.

Parameters:

body - Public ID list of the Synthetic tests to be deleted. (required)

Returns:

ApiResponse<SyntheticsDeleteTestsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK.	-
400	- JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user	-
403	Forbidden	-
404	- Tests to be deleted can't be found - Synthetic is not activated for the user	-
429	Too many requests	-

deleteTestsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsDeleteTestsResponse>> deleteTestsWithHttpInfoAsync(SyntheticsDeleteTestsPayload body)

Delete tests.

See deleteTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).

Parameters:

body - Public ID list of the Synthetic tests to be deleted. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsDeleteTestsResponse>>

editGlobalVariable

public SyntheticsGlobalVariable editGlobalVariable(String variableId,
                                                   SyntheticsGlobalVariable body)
                                            throws ApiException

Edit a global variable.

See editGlobalVariableWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

variableId - The ID of the global variable. (required)

body - Details of the global variable to update. (required)

Returns:

SyntheticsGlobalVariable

Throws:

ApiException - if fails to make API call

editGlobalVariableAsync

public CompletableFuture<SyntheticsGlobalVariable> editGlobalVariableAsync(String variableId,
                                                                           SyntheticsGlobalVariable body)

Edit a global variable.

See editGlobalVariableWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

variableId - The ID of the global variable. (required)

body - Details of the global variable to update. (required)

Returns:

CompletableFuture<SyntheticsGlobalVariable>

editGlobalVariableWithHttpInfo

public ApiResponse<SyntheticsGlobalVariable> editGlobalVariableWithHttpInfo(String variableId,
                                                                            SyntheticsGlobalVariable body)
                                                                     throws ApiException

Edit a Synthetic global variable.

Parameters:

variableId - The ID of the global variable. (required)

body - Details of the global variable to update. (required)

Returns:

ApiResponse<SyntheticsGlobalVariable>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid request	-
403	Forbidden	-
429	Too many requests	-

editGlobalVariableWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> editGlobalVariableWithHttpInfoAsync(String variableId,
                                                                                                    SyntheticsGlobalVariable body)

Edit a global variable.

See editGlobalVariableWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsGlobalVariable).

Parameters:

variableId - The ID of the global variable. (required)

body - Details of the global variable to update. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>

getAPITest

public SyntheticsAPITest getAPITest(String publicId)
                             throws ApiException

Get an API test.

See getAPITestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

SyntheticsAPITest

Throws:

ApiException - if fails to make API call

getAPITestAsync

public CompletableFuture<SyntheticsAPITest> getAPITestAsync(String publicId)

Get an API test.

See getAPITestWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<SyntheticsAPITest>

getAPITestWithHttpInfo

public ApiResponse<SyntheticsAPITest> getAPITestWithHttpInfo(String publicId)
                                                      throws ApiException

Get the detailed configuration associated with a Synthetic API test.

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

ApiResponse<SyntheticsAPITest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

getAPITestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsAPITest>> getAPITestWithHttpInfoAsync(String publicId)

Get an API test.

See getAPITestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsAPITest>>

getAPITestLatestResults

public SyntheticsGetAPITestLatestResultsResponse getAPITestLatestResults(String publicId)
                                                                  throws ApiException

Get an API test's latest results summaries.

See getAPITestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetAPITestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the test for which to search results for. (required)

Returns:

SyntheticsGetAPITestLatestResultsResponse

Throws:

ApiException - if fails to make API call

getAPITestLatestResultsAsync

public CompletableFuture<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsAsync(String publicId)

Get an API test's latest results summaries.

See getAPITestLatestResultsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetAPITestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the test for which to search results for. (required)

Returns:

CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>

getAPITestLatestResults

public SyntheticsGetAPITestLatestResultsResponse getAPITestLatestResults(String publicId,
                                                                         SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters)
                                                                  throws ApiException

Get an API test's latest results summaries.

See getAPITestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetAPITestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

SyntheticsGetAPITestLatestResultsResponse

Throws:

ApiException - if fails to make API call

getAPITestLatestResultsAsync

public CompletableFuture<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsAsync(String publicId,
                                                                                                 SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters)

Get an API test's latest results summaries.

See getAPITestLatestResultsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetAPITestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>

getAPITestLatestResultsWithHttpInfo

public ApiResponse<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsWithHttpInfo(String publicId,
                                                                                                  SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters)
                                                                                           throws ApiException

Get the last 150 test results summaries for a given Synthetic API test.

Parameters:

publicId - The public ID of the test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<SyntheticsGetAPITestLatestResultsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

getAPITestLatestResultsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsGetAPITestLatestResultsResponse>> getAPITestLatestResultsWithHttpInfoAsync(String publicId,
                                                                                                                          SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters)

Get an API test's latest results summaries.

See getAPITestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetAPITestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SyntheticsGetAPITestLatestResultsResponse>>

getAPITestResult

public SyntheticsAPITestResultFull getAPITestResult(String publicId,
                                                    String resultId)
                                             throws ApiException

Get an API test result.

See getAPITestResultWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the API test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

SyntheticsAPITestResultFull

Throws:

ApiException - if fails to make API call

getAPITestResultAsync

public CompletableFuture<SyntheticsAPITestResultFull> getAPITestResultAsync(String publicId,
                                                                            String resultId)

Get an API test result.

See getAPITestResultWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the API test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

CompletableFuture<SyntheticsAPITestResultFull>

getAPITestResultWithHttpInfo

public ApiResponse<SyntheticsAPITestResultFull> getAPITestResultWithHttpInfo(String publicId,
                                                                             String resultId)
                                                                      throws ApiException

Get a specific full result from a given Synthetic API test.

Parameters:

publicId - The public ID of the API test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

ApiResponse<SyntheticsAPITestResultFull>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test or result is not owned by the user	-
429	Too many requests	-

getAPITestResultWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsAPITestResultFull>> getAPITestResultWithHttpInfoAsync(String publicId,
                                                                                                     String resultId)

Get an API test result.

See getAPITestResultWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the API test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsAPITestResultFull>>

getBrowserTest

public SyntheticsBrowserTest getBrowserTest(String publicId)
                                     throws ApiException

Get a browser test.

See getBrowserTestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

SyntheticsBrowserTest

Throws:

ApiException - if fails to make API call

getBrowserTestAsync

public CompletableFuture<SyntheticsBrowserTest> getBrowserTestAsync(String publicId)

Get a browser test.

See getBrowserTestWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<SyntheticsBrowserTest>

getBrowserTestWithHttpInfo

public ApiResponse<SyntheticsBrowserTest> getBrowserTestWithHttpInfo(String publicId)
                                                              throws ApiException

Get the detailed configuration (including steps) associated with a Synthetic browser test.

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

ApiResponse<SyntheticsBrowserTest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

getBrowserTestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> getBrowserTestWithHttpInfoAsync(String publicId)

Get a browser test.

See getBrowserTestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsBrowserTest>>

getBrowserTestLatestResults

public SyntheticsGetBrowserTestLatestResultsResponse getBrowserTestLatestResults(String publicId)
                                                                          throws ApiException

Get a browser test's latest results summaries.

See getBrowserTestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

Returns:

SyntheticsGetBrowserTestLatestResultsResponse

Throws:

ApiException - if fails to make API call

getBrowserTestLatestResultsAsync

public CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsAsync(String publicId)

Get a browser test's latest results summaries.

See getBrowserTestLatestResultsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

Returns:

CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>

getBrowserTestLatestResults

public SyntheticsGetBrowserTestLatestResultsResponse getBrowserTestLatestResults(String publicId,
                                                                                 SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters)
                                                                          throws ApiException

Get a browser test's latest results summaries.

See getBrowserTestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

SyntheticsGetBrowserTestLatestResultsResponse

Throws:

ApiException - if fails to make API call

getBrowserTestLatestResultsAsync

public CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsAsync(String publicId,
                                                                                                         SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters)

Get a browser test's latest results summaries.

See getBrowserTestLatestResultsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>

getBrowserTestLatestResultsWithHttpInfo

public ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsWithHttpInfo(String publicId,
                                                                                                          SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters)
                                                                                                   throws ApiException

Get the last 150 test results summaries for a given Synthetic browser test.

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

getBrowserTestLatestResultsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>> getBrowserTestLatestResultsWithHttpInfoAsync(String publicId,
                                                                                                                                  SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters)

Get a browser test's latest results summaries.

See getBrowserTestLatestResultsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters).

Parameters:

publicId - The public ID of the browser test for which to search results for. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>>

getBrowserTestResult

public SyntheticsBrowserTestResultFull getBrowserTestResult(String publicId,
                                                            String resultId)
                                                     throws ApiException

Get a browser test result.

See getBrowserTestResultWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the browser test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

SyntheticsBrowserTestResultFull

Throws:

ApiException - if fails to make API call

getBrowserTestResultAsync

public CompletableFuture<SyntheticsBrowserTestResultFull> getBrowserTestResultAsync(String publicId,
                                                                                    String resultId)

Get a browser test result.

See getBrowserTestResultWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the browser test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

CompletableFuture<SyntheticsBrowserTestResultFull>

getBrowserTestResultWithHttpInfo

public ApiResponse<SyntheticsBrowserTestResultFull> getBrowserTestResultWithHttpInfo(String publicId,
                                                                                     String resultId)
                                                                              throws ApiException

Get a specific full result from a given Synthetic browser test.

Parameters:

publicId - The public ID of the browser test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

ApiResponse<SyntheticsBrowserTestResultFull>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test or result is not owned by the user	-
429	Too many requests	-

getBrowserTestResultWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsBrowserTestResultFull>> getBrowserTestResultWithHttpInfoAsync(String publicId,
                                                                                                             String resultId)

Get a browser test result.

See getBrowserTestResultWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

publicId - The public ID of the browser test to which the target result belongs. (required)

resultId - The ID of the result to get. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsBrowserTestResultFull>>

getGlobalVariable

public SyntheticsGlobalVariable getGlobalVariable(String variableId)
                                           throws ApiException

Get a global variable.

See getGlobalVariableWithHttpInfo(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Returns:

SyntheticsGlobalVariable

Throws:

ApiException - if fails to make API call

getGlobalVariableAsync

public CompletableFuture<SyntheticsGlobalVariable> getGlobalVariableAsync(String variableId)

Get a global variable.

See getGlobalVariableWithHttpInfoAsync(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Returns:

CompletableFuture<SyntheticsGlobalVariable>

getGlobalVariableWithHttpInfo

public ApiResponse<SyntheticsGlobalVariable> getGlobalVariableWithHttpInfo(String variableId)
                                                                    throws ApiException

Get the detailed configuration of a global variable.

Parameters:

variableId - The ID of the global variable. (required)

Returns:

ApiResponse<SyntheticsGlobalVariable>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

getGlobalVariableWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> getGlobalVariableWithHttpInfoAsync(String variableId)

Get a global variable.

See getGlobalVariableWithHttpInfo(java.lang.String).

Parameters:

variableId - The ID of the global variable. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>

getPrivateLocation

public SyntheticsPrivateLocation getPrivateLocation(String locationId)
                                             throws ApiException

Get a private location.

See getPrivateLocationWithHttpInfo(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Returns:

SyntheticsPrivateLocation

Throws:

ApiException - if fails to make API call

getPrivateLocationAsync

public CompletableFuture<SyntheticsPrivateLocation> getPrivateLocationAsync(String locationId)

Get a private location.

See getPrivateLocationWithHttpInfoAsync(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Returns:

CompletableFuture<SyntheticsPrivateLocation>

getPrivateLocationWithHttpInfo

public ApiResponse<SyntheticsPrivateLocation> getPrivateLocationWithHttpInfo(String locationId)
                                                                      throws ApiException

Get a Synthetic private location.

Parameters:

locationId - The ID of the private location. (required)

Returns:

ApiResponse<SyntheticsPrivateLocation>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	- Synthetic private locations are not activated for the user - Private location does not exist	-
429	Too many requests	-

getPrivateLocationWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsPrivateLocation>> getPrivateLocationWithHttpInfoAsync(String locationId)

Get a private location.

See getPrivateLocationWithHttpInfo(java.lang.String).

Parameters:

locationId - The ID of the private location. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>

getSyntheticsCIBatch

public SyntheticsBatchDetails getSyntheticsCIBatch(String batchId)
                                            throws ApiException

Get details of batch.

See getSyntheticsCIBatchWithHttpInfo(java.lang.String).

Parameters:

batchId - The ID of the batch. (required)

Returns:

SyntheticsBatchDetails

Throws:

ApiException - if fails to make API call

getSyntheticsCIBatchAsync

public CompletableFuture<SyntheticsBatchDetails> getSyntheticsCIBatchAsync(String batchId)

Get details of batch.

See getSyntheticsCIBatchWithHttpInfoAsync(java.lang.String).

Parameters:

batchId - The ID of the batch. (required)

Returns:

CompletableFuture<SyntheticsBatchDetails>

getSyntheticsCIBatchWithHttpInfo

public ApiResponse<SyntheticsBatchDetails> getSyntheticsCIBatchWithHttpInfo(String batchId)
                                                                     throws ApiException

Get a batch's updated details.

Parameters:

batchId - The ID of the batch. (required)

Returns:

ApiResponse<SyntheticsBatchDetails>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	Batch does not exist.	-
429	Too many requests	-

getSyntheticsCIBatchWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsBatchDetails>> getSyntheticsCIBatchWithHttpInfoAsync(String batchId)

Get details of batch.

See getSyntheticsCIBatchWithHttpInfo(java.lang.String).

Parameters:

batchId - The ID of the batch. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsBatchDetails>>

getSyntheticsDefaultLocations

public List<String> getSyntheticsDefaultLocations()
                                           throws ApiException

Get the default locations.

See getSyntheticsDefaultLocationsWithHttpInfo().

Returns:

List<String>

Throws:

ApiException - if fails to make API call

getSyntheticsDefaultLocationsAsync

public CompletableFuture<List<String>> getSyntheticsDefaultLocationsAsync()

Get the default locations.

See getSyntheticsDefaultLocationsWithHttpInfoAsync().

Returns:

CompletableFuture<List<String>>

getSyntheticsDefaultLocationsWithHttpInfo

public ApiResponse<List<String>> getSyntheticsDefaultLocationsWithHttpInfo()
                                                                    throws ApiException

Get the default locations settings.

Returns:

ApiResponse<List<String>>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
429	Too many requests	-

getSyntheticsDefaultLocationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<List<String>>> getSyntheticsDefaultLocationsWithHttpInfoAsync()

Get the default locations.

See getSyntheticsDefaultLocationsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<List<String>>>

getTest

public SyntheticsTestDetails getTest(String publicId)
                              throws ApiException

Get a test configuration.

See getTestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

SyntheticsTestDetails

Throws:

ApiException - if fails to make API call

getTestAsync

public CompletableFuture<SyntheticsTestDetails> getTestAsync(String publicId)

Get a test configuration.

See getTestWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<SyntheticsTestDetails>

getTestWithHttpInfo

public ApiResponse<SyntheticsTestDetails> getTestWithHttpInfo(String publicId)
                                                       throws ApiException

Get the detailed configuration associated with a Synthetic test.

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

ApiResponse<SyntheticsTestDetails>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	- Synthetic is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

getTestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsTestDetails>> getTestWithHttpInfoAsync(String publicId)

Get a test configuration.

See getTestWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the test to get details from. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsTestDetails>>

listGlobalVariables

public SyntheticsListGlobalVariablesResponse listGlobalVariables()
                                                          throws ApiException

Get all global variables.

See listGlobalVariablesWithHttpInfo().

Returns:

SyntheticsListGlobalVariablesResponse

Throws:

ApiException - if fails to make API call

listGlobalVariablesAsync

public CompletableFuture<SyntheticsListGlobalVariablesResponse> listGlobalVariablesAsync()

Get all global variables.

See listGlobalVariablesWithHttpInfoAsync().

Returns:

CompletableFuture<SyntheticsListGlobalVariablesResponse>

listGlobalVariablesWithHttpInfo

public ApiResponse<SyntheticsListGlobalVariablesResponse> listGlobalVariablesWithHttpInfo()
                                                                                   throws ApiException

Get the list of all Synthetic global variables.

Returns:

ApiResponse<SyntheticsListGlobalVariablesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listGlobalVariablesWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsListGlobalVariablesResponse>> listGlobalVariablesWithHttpInfoAsync()

Get all global variables.

See listGlobalVariablesWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<SyntheticsListGlobalVariablesResponse>>

listLocations

public SyntheticsLocations listLocations()
                                  throws ApiException

Get all locations (public and private).

See listLocationsWithHttpInfo().

Returns:

SyntheticsLocations

Throws:

ApiException - if fails to make API call

listLocationsAsync

public CompletableFuture<SyntheticsLocations> listLocationsAsync()

Get all locations (public and private).

See listLocationsWithHttpInfoAsync().

Returns:

CompletableFuture<SyntheticsLocations>

listLocationsWithHttpInfo

public ApiResponse<SyntheticsLocations> listLocationsWithHttpInfo()
                                                           throws ApiException

Get the list of public and private locations available for Synthetic tests. No arguments required.

Returns:

ApiResponse<SyntheticsLocations>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
429	Too many requests	-

listLocationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsLocations>> listLocationsWithHttpInfoAsync()

Get all locations (public and private).

See listLocationsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<SyntheticsLocations>>

listTests

public SyntheticsListTestsResponse listTests()
                                      throws ApiException

Get the list of all Synthetic tests.

See listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Returns:

SyntheticsListTestsResponse

Throws:

ApiException - if fails to make API call

listTestsAsync

public CompletableFuture<SyntheticsListTestsResponse> listTestsAsync()

Get the list of all Synthetic tests.

See listTestsWithHttpInfoAsync(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Returns:

CompletableFuture<SyntheticsListTestsResponse>

listTests

public SyntheticsListTestsResponse listTests(SyntheticsApi.ListTestsOptionalParameters parameters)
                                      throws ApiException

Get the list of all Synthetic tests.

See listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

SyntheticsListTestsResponse

Throws:

ApiException - if fails to make API call

listTestsAsync

public CompletableFuture<SyntheticsListTestsResponse> listTestsAsync(SyntheticsApi.ListTestsOptionalParameters parameters)

Get the list of all Synthetic tests.

See listTestsWithHttpInfoAsync(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SyntheticsListTestsResponse>

listTestsWithPagination

public PaginationIterable<SyntheticsTestDetails> listTestsWithPagination()

Get the list of all Synthetic tests.

See listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Returns:

PaginationIterable<SyntheticsTestDetails>

listTestsWithPagination

public PaginationIterable<SyntheticsTestDetails> listTestsWithPagination(SyntheticsApi.ListTestsOptionalParameters parameters)

Get the list of all Synthetic tests.

See listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Returns:

SyntheticsListTestsResponse

listTestsWithHttpInfo

public ApiResponse<SyntheticsListTestsResponse> listTestsWithHttpInfo(SyntheticsApi.ListTestsOptionalParameters parameters)
                                                               throws ApiException

Get the list of all Synthetic tests.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<SyntheticsListTestsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK - Returns the list of all Synthetic tests.	-
403	Forbidden	-
404	Synthetic Monitoring is not activated for the user.	-
429	Too many requests	-

listTestsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsListTestsResponse>> listTestsWithHttpInfoAsync(SyntheticsApi.ListTestsOptionalParameters parameters)

Get the list of all Synthetic tests.

See listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SyntheticsListTestsResponse>>

patchTest

public SyntheticsTestDetails patchTest(String publicId,
                                       SyntheticsPatchTestBody body)
                                throws ApiException

Patch a Synthetic test.

See patchTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPatchTestBody).

Parameters:

publicId - The public ID of the test to patch. (required)

body - JSON Patch compliant list of operations (required)

Returns:

SyntheticsTestDetails

Throws:

ApiException - if fails to make API call

patchTestAsync

public CompletableFuture<SyntheticsTestDetails> patchTestAsync(String publicId,
                                                               SyntheticsPatchTestBody body)

Patch a Synthetic test.

See patchTestWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPatchTestBody).

Parameters:

publicId - The public ID of the test to patch. (required)

body - JSON Patch compliant list of operations (required)

Returns:

CompletableFuture<SyntheticsTestDetails>

patchTestWithHttpInfo

public ApiResponse<SyntheticsTestDetails> patchTestWithHttpInfo(String publicId,
                                                                SyntheticsPatchTestBody body)
                                                         throws ApiException

Patch the configuration of a Synthetic test with partial data.

Parameters:

publicId - The public ID of the test to patch. (required)

body - JSON Patch compliant list of operations (required)

Returns:

ApiResponse<SyntheticsTestDetails>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	- JSON format is wrong - Updating sub-type is forbidden	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found	-
429	Too many requests	-

patchTestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsTestDetails>> patchTestWithHttpInfoAsync(String publicId,
                                                                                        SyntheticsPatchTestBody body)

Patch a Synthetic test.

See patchTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPatchTestBody).

Parameters:

publicId - The public ID of the test to patch. (required)

body - JSON Patch compliant list of operations (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsTestDetails>>

triggerCITests

public SyntheticsTriggerCITestsResponse triggerCITests(SyntheticsCITestBody body)
                                                throws ApiException

Trigger tests from CI/CD pipelines.

See triggerCITestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsCITestBody).

Parameters:

body - Details of the test to trigger. (required)

Returns:

SyntheticsTriggerCITestsResponse

Throws:

ApiException - if fails to make API call

triggerCITestsAsync

public CompletableFuture<SyntheticsTriggerCITestsResponse> triggerCITestsAsync(SyntheticsCITestBody body)

Trigger tests from CI/CD pipelines.

See triggerCITestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsCITestBody).

Parameters:

body - Details of the test to trigger. (required)

Returns:

CompletableFuture<SyntheticsTriggerCITestsResponse>

triggerCITestsWithHttpInfo

public ApiResponse<SyntheticsTriggerCITestsResponse> triggerCITestsWithHttpInfo(SyntheticsCITestBody body)
                                                                         throws ApiException

Trigger a set of Synthetic tests for continuous integration.

Parameters:

body - Details of the test to trigger. (required)

Returns:

ApiResponse<SyntheticsTriggerCITestsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	JSON format is wrong	-
429	Too many requests	-

triggerCITestsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>> triggerCITestsWithHttpInfoAsync(SyntheticsCITestBody body)

Trigger tests from CI/CD pipelines.

See triggerCITestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsCITestBody).

Parameters:

body - Details of the test to trigger. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>

triggerTests

public SyntheticsTriggerCITestsResponse triggerTests(SyntheticsTriggerBody body)
                                              throws ApiException

Trigger Synthetic tests.

See triggerTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsTriggerBody).

Parameters:

body - The identifiers of the tests to trigger. (required)

Returns:

SyntheticsTriggerCITestsResponse

Throws:

ApiException - if fails to make API call

triggerTestsAsync

public CompletableFuture<SyntheticsTriggerCITestsResponse> triggerTestsAsync(SyntheticsTriggerBody body)

Trigger Synthetic tests.

See triggerTestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsTriggerBody).

Parameters:

body - The identifiers of the tests to trigger. (required)

Returns:

CompletableFuture<SyntheticsTriggerCITestsResponse>

triggerTestsWithHttpInfo

public ApiResponse<SyntheticsTriggerCITestsResponse> triggerTestsWithHttpInfo(SyntheticsTriggerBody body)
                                                                       throws ApiException

Trigger a set of Synthetic tests.

Parameters:

body - The identifiers of the tests to trigger. (required)

Returns:

ApiResponse<SyntheticsTriggerCITestsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
429	Too many requests	-

triggerTestsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>> triggerTestsWithHttpInfoAsync(SyntheticsTriggerBody body)

Trigger Synthetic tests.

See triggerTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsTriggerBody).

Parameters:

body - The identifiers of the tests to trigger. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>

updateAPITest

public SyntheticsAPITest updateAPITest(String publicId,
                                       SyntheticsAPITest body)
                                throws ApiException

Edit an API test.

See updateAPITestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

publicId - The public ID of the test to get details from. (required)

body - New test details to be saved. (required)

Returns:

SyntheticsAPITest

Throws:

ApiException - if fails to make API call

updateAPITestAsync

public CompletableFuture<SyntheticsAPITest> updateAPITestAsync(String publicId,
                                                               SyntheticsAPITest body)

Edit an API test.

See updateAPITestWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

publicId - The public ID of the test to get details from. (required)

body - New test details to be saved. (required)

Returns:

CompletableFuture<SyntheticsAPITest>

updateAPITestWithHttpInfo

public ApiResponse<SyntheticsAPITest> updateAPITestWithHttpInfo(String publicId,
                                                                SyntheticsAPITest body)
                                                         throws ApiException

Edit the configuration of a Synthetic API test.

Parameters:

publicId - The public ID of the test to get details from. (required)

body - New test details to be saved. (required)

Returns:

ApiResponse<SyntheticsAPITest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	- JSON format is wrong - Updating sub-type is forbidden	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found	-
429	Too many requests	-

updateAPITestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsAPITest>> updateAPITestWithHttpInfoAsync(String publicId,
                                                                                        SyntheticsAPITest body)

Edit an API test.

See updateAPITestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).

Parameters:

publicId - The public ID of the test to get details from. (required)

body - New test details to be saved. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsAPITest>>

updateBrowserTest

public SyntheticsBrowserTest updateBrowserTest(String publicId,
                                               SyntheticsBrowserTest body)
                                        throws ApiException

Edit a browser test.

See updateBrowserTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

publicId - The public ID of the test to edit. (required)

body - New test details to be saved. (required)

Returns:

SyntheticsBrowserTest

Throws:

ApiException - if fails to make API call

updateBrowserTestAsync

public CompletableFuture<SyntheticsBrowserTest> updateBrowserTestAsync(String publicId,
                                                                       SyntheticsBrowserTest body)

Edit a browser test.

See updateBrowserTestWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

publicId - The public ID of the test to edit. (required)

body - New test details to be saved. (required)

Returns:

CompletableFuture<SyntheticsBrowserTest>

updateBrowserTestWithHttpInfo

public ApiResponse<SyntheticsBrowserTest> updateBrowserTestWithHttpInfo(String publicId,
                                                                        SyntheticsBrowserTest body)
                                                                 throws ApiException

Edit the configuration of a Synthetic browser test.

Parameters:

publicId - The public ID of the test to edit. (required)

body - New test details to be saved. (required)

Returns:

ApiResponse<SyntheticsBrowserTest>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	- JSON format is wrong - Updating sub-type is forbidden	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found	-
429	Too many requests	-

updateBrowserTestWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> updateBrowserTestWithHttpInfoAsync(String publicId,
                                                                                                SyntheticsBrowserTest body)

Edit a browser test.

See updateBrowserTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsBrowserTest).

Parameters:

publicId - The public ID of the test to edit. (required)

body - New test details to be saved. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsBrowserTest>>

updatePrivateLocation

public SyntheticsPrivateLocation updatePrivateLocation(String locationId,
                                                       SyntheticsPrivateLocation body)
                                                throws ApiException

Edit a private location.

See updatePrivateLocationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

locationId - The ID of the private location. (required)

body - Details of the private location to be updated. (required)

Returns:

SyntheticsPrivateLocation

Throws:

ApiException - if fails to make API call

updatePrivateLocationAsync

public CompletableFuture<SyntheticsPrivateLocation> updatePrivateLocationAsync(String locationId,
                                                                               SyntheticsPrivateLocation body)

Edit a private location.

See updatePrivateLocationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

locationId - The ID of the private location. (required)

body - Details of the private location to be updated. (required)

Returns:

CompletableFuture<SyntheticsPrivateLocation>

updatePrivateLocationWithHttpInfo

public ApiResponse<SyntheticsPrivateLocation> updatePrivateLocationWithHttpInfo(String locationId,
                                                                                SyntheticsPrivateLocation body)
                                                                         throws ApiException

Edit a Synthetic private location.

Parameters:

locationId - The ID of the private location. (required)

body - Details of the private location to be updated. (required)

Returns:

ApiResponse<SyntheticsPrivateLocation>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	- Private locations are not activated for the user - Private location does not exist	-
429	Too many requests	-

updatePrivateLocationWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsPrivateLocation>> updatePrivateLocationWithHttpInfoAsync(String locationId,
                                                                                                        SyntheticsPrivateLocation body)

Edit a private location.

See updatePrivateLocationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPrivateLocation).

Parameters:

locationId - The ID of the private location. (required)

body - Details of the private location to be updated. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>

updateTestPauseStatus

public Boolean updateTestPauseStatus(String publicId,
                                     SyntheticsUpdateTestPauseStatusPayload body)
                              throws ApiException

Pause or start a test.

See updateTestPauseStatusWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsUpdateTestPauseStatusPayload).

Parameters:

publicId - The public ID of the Synthetic test to update. (required)

body - Status to set the given Synthetic test to. (required)

Returns:

Boolean

Throws:

ApiException - if fails to make API call

updateTestPauseStatusAsync

public CompletableFuture<Boolean> updateTestPauseStatusAsync(String publicId,
                                                             SyntheticsUpdateTestPauseStatusPayload body)

Pause or start a test.

See updateTestPauseStatusWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsUpdateTestPauseStatusPayload).

Parameters:

publicId - The public ID of the Synthetic test to update. (required)

body - Status to set the given Synthetic test to. (required)

Returns:

CompletableFuture<Boolean>

updateTestPauseStatusWithHttpInfo

public ApiResponse<Boolean> updateTestPauseStatusWithHttpInfo(String publicId,
                                                              SyntheticsUpdateTestPauseStatusPayload body)
                                                       throws ApiException

Pause or start a Synthetic test by changing the status.

Parameters:

publicId - The public ID of the Synthetic test to update. (required)

body - Status to set the given Synthetic test to. (required)

Returns:

ApiResponse<Boolean>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK - Returns a boolean indicating if the update was successful.	-
400	JSON format is wrong.	-
403	Forbidden	-
404	- Synthetic Monitoring is not activated for the user - Test is not owned by the user	-
429	Too many requests	-

updateTestPauseStatusWithHttpInfoAsync

public CompletableFuture<ApiResponse<Boolean>> updateTestPauseStatusWithHttpInfoAsync(String publicId,
                                                                                      SyntheticsUpdateTestPauseStatusPayload body)

Pause or start a test.

See updateTestPauseStatusWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsUpdateTestPauseStatusPayload).

Parameters:

publicId - The public ID of the Synthetic test to update. (required)

body - Status to set the given Synthetic test to. (required)

Returns:

CompletableFuture<ApiResponse<Boolean>>