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"}}
"""
Get a suite returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.synthetics_apiimportSyntheticsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=SyntheticsApi(api_client)response=api_instance.get_synthetics_suite(public_id="public_id",)print(response)
# Get a suite returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::SyntheticsAPI.newpapi_instance.get_synthetics_suite("public_id")
// Get a 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(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSyntheticsApi(apiClient)resp,r,err:=api.GetSyntheticsSuite(ctx,"public_id")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SyntheticsApi.GetSyntheticsSuite`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SyntheticsApi.GetSyntheticsSuite`:\n%s\n",responseContent)}
// Get a 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.SyntheticsSuiteResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();SyntheticsApiapiInstance=newSyntheticsApi(defaultClient);try{SyntheticsSuiteResponseresult=apiInstance.getSyntheticsSuite("public_id");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SyntheticsApi#getSyntheticsSuite");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a suite returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_synthetics::SyntheticsAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=SyntheticsAPI::with_config(configuration);letresp=api.get_synthetics_suite("public_id".to_string()).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
/**
* Get a suite returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.SyntheticsApi(configuration);constparams: v2.SyntheticsApiGetSyntheticsSuiteRequest={publicId:"public_id",};apiInstance.getSyntheticsSuite(params).then((data: v2.SyntheticsSuiteResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));