Object containing details about a Synthetic suite.
message
string
Notification message associated with the suite.
monitor_id
int64
The associated monitor ID.
name [required]
string
Name of the suite.
options [required]
object
Object describing the extra options for a Synthetic suite.
alerting_threshold
double
Percentage of critical tests failure needed for a suite to fail.
public_id
string
The public ID for the test.
tags
[string]
Array of tags attached to the suite.
tests [required]
[object]
Array of Synthetic tests included in the suite.
alerting_criticality
enum
Alerting criticality for each the test.
Allowed enum values: ignore,critical
public_id [required]
string
The public ID of the Synthetic test included in the suite.
type [required]
enum
Type of the Synthetic suite, suite.
Allowed enum values: suite
default: suite
id
string
The public ID for the suite.
type
enum
Type for the Synthetics suites responses, suites.
Allowed enum values: suites
default: suites
{"data":{"attributes":{"message":"Notification message","monitor_id":12345678,"name":"Example suite name","options":{"alerting_threshold":"number"},"public_id":"123-abc-456","tags":["env:production"],"tests":[{"alerting_criticality":"critical","public_id":""}],"type":"suite"},"id":"123-abc-456","type":"suites"}}
"""
Patch a test suite returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.synthetics_apiimportSyntheticsApifromdatadog_api_client.v2.model.json_patch_operationimportJsonPatchOperationfromdatadog_api_client.v2.model.json_patch_operation_opimportJsonPatchOperationOpfromdatadog_api_client.v2.model.suite_json_patch_requestimportSuiteJsonPatchRequestfromdatadog_api_client.v2.model.suite_json_patch_request_dataimportSuiteJsonPatchRequestDatafromdatadog_api_client.v2.model.suite_json_patch_request_data_attributesimportSuiteJsonPatchRequestDataAttributesfromdatadog_api_client.v2.model.suite_json_patch_typeimportSuiteJsonPatchTypebody=SuiteJsonPatchRequest(data=SuiteJsonPatchRequestData(attributes=SuiteJsonPatchRequestDataAttributes(json_patch=[JsonPatchOperation(op=JsonPatchOperationOp.ADD,path="/name",),],),type=SuiteJsonPatchType.SUITES_JSON_PATCH,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=SyntheticsApi(api_client)response=api_instance.patch_test_suite(public_id="123-abc-456",body=body)print(response)
# Patch a test suite returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SyntheticsAPI.newbody=DatadogAPIClient::V2::SuiteJsonPatchRequest.new({data:DatadogAPIClient::V2::SuiteJsonPatchRequestData.new({attributes:DatadogAPIClient::V2::SuiteJsonPatchRequestDataAttributes.new({json_patch:[DatadogAPIClient::V2::JsonPatchOperation.new({op:DatadogAPIClient::V2::JsonPatchOperationOp::ADD,path:"/name",}),],}),type:DatadogAPIClient::V2::SuiteJsonPatchType::SUITES_JSON_PATCH,}),})papi_instance.patch_test_suite("123-abc-456",body)
// Patch a test suite returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){body:=datadogV2.SuiteJsonPatchRequest{Data:datadogV2.SuiteJsonPatchRequestData{Attributes:&datadogV2.SuiteJsonPatchRequestDataAttributes{JsonPatch:[]datadogV2.JsonPatchOperation{{Op:datadogV2.JSONPATCHOPERATIONOP_ADD,Path:"/name",},},},Type:datadogV2.SUITEJSONPATCHTYPE_SUITES_JSON_PATCH.Ptr(),},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSyntheticsApi(apiClient)resp,r,err:=api.PatchTestSuite(ctx,"123-abc-456",body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SyntheticsApi.PatchTestSuite`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SyntheticsApi.PatchTestSuite`:\n%s\n",responseContent)}
// Patch a test suite returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SyntheticsApi;importcom.datadog.api.client.v2.model.JsonPatchOperation;importcom.datadog.api.client.v2.model.JsonPatchOperationOp;importcom.datadog.api.client.v2.model.SuiteJsonPatchRequest;importcom.datadog.api.client.v2.model.SuiteJsonPatchRequestData;importcom.datadog.api.client.v2.model.SuiteJsonPatchRequestDataAttributes;importcom.datadog.api.client.v2.model.SuiteJsonPatchType;importcom.datadog.api.client.v2.model.SyntheticsSuiteResponse;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SyntheticsApiapiInstance=newSyntheticsApi(defaultClient);SuiteJsonPatchRequestbody=newSuiteJsonPatchRequest().data(newSuiteJsonPatchRequestData().attributes(newSuiteJsonPatchRequestDataAttributes().jsonPatch(Collections.singletonList(newJsonPatchOperation().op(JsonPatchOperationOp.ADD).path("/name")))).type(SuiteJsonPatchType.SUITES_JSON_PATCH));try{SyntheticsSuiteResponseresult=apiInstance.patchTestSuite("123-abc-456",body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SyntheticsApi#patchTestSuite");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Patch a test suite returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_synthetics::SyntheticsAPI;usedatadog_api_client::datadogV2::model::JsonPatchOperation;usedatadog_api_client::datadogV2::model::JsonPatchOperationOp;usedatadog_api_client::datadogV2::model::SuiteJsonPatchRequest;usedatadog_api_client::datadogV2::model::SuiteJsonPatchRequestData;usedatadog_api_client::datadogV2::model::SuiteJsonPatchRequestDataAttributes;usedatadog_api_client::datadogV2::model::SuiteJsonPatchType;#[tokio::main]asyncfnmain(){letbody=SuiteJsonPatchRequest::new(SuiteJsonPatchRequestData::new().attributes(SuiteJsonPatchRequestDataAttributes::new().json_patch(vec![JsonPatchOperation::new(JsonPatchOperationOp::ADD,"/name".to_string()),])).type_(SuiteJsonPatchType::SUITES_JSON_PATCH),);letconfiguration=datadog::Configuration::new();letapi=SyntheticsAPI::with_config(configuration);letresp=api.patch_test_suite("123-abc-456".to_string(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Patch a test suite returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SyntheticsApi(configuration);constparams: v2.SyntheticsApiPatchTestSuiteRequest={body:{data:{attributes:{jsonPatch:[{op:"add",path:"/name",},],},type:"suites_json_patch",},},publicId:"123-abc-456",};apiInstance.patchTestSuite(params).then((data: v2.SyntheticsSuiteResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));