Attributes for creating or updating a rule. Server-managed fields (created_at, modified_at, custom) are excluded.
description
string
Explanation of the rule.
enabled
boolean
If enabled, the rule is calculated as part of the score.
level
int32
The maturity level of the rule (1, 2, or 3).
name
string
Name of the rule.
owner
string
Owner of the rule.
scope_query
string
A query to filter which entities this rule applies to.
scorecard_name
string
The scorecard name to which this rule must belong.
type
enum
The JSON:API type for scorecard rules.
Allowed enum values: rule
default: rule
{"data":{"type":"rule","attributes":{"enabled":true,"name":"Team Defined","scorecard_name":"Deployments automated via Deployment Trains","description":"Updated description via test"}}}
// Update an existing rule returns "Rule updated successfully" 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(){// there is a valid "create_scorecard_rule" in the systemCreateScorecardRuleDataAttributesName:=os.Getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME")CreateScorecardRuleDataAttributesScorecardName:=os.Getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME")CreateScorecardRuleDataID:=os.Getenv("CREATE_SCORECARD_RULE_DATA_ID")body:=datadogV2.UpdateRuleRequest{Data:&datadogV2.UpdateRuleRequestData{Type:datadogV2.RULETYPE_RULE.Ptr(),Attributes:&datadogV2.RuleAttributesRequest{Enabled:datadog.PtrBool(true),Name:datadog.PtrString(CreateScorecardRuleDataAttributesName),ScorecardName:datadog.PtrString(CreateScorecardRuleDataAttributesScorecardName),Description:datadog.PtrString("Updated description via test"),},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewScorecardsApi(apiClient)resp,r,err:=api.UpdateScorecardRule(ctx,CreateScorecardRuleDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ScorecardsApi.UpdateScorecardRule`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ScorecardsApi.UpdateScorecardRule`:\n%s\n",responseContent)}
// Update an existing rule returns "Rule updated successfully" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ScorecardsApi;importcom.datadog.api.client.v2.model.RuleAttributesRequest;importcom.datadog.api.client.v2.model.RuleType;importcom.datadog.api.client.v2.model.UpdateRuleRequest;importcom.datadog.api.client.v2.model.UpdateRuleRequestData;importcom.datadog.api.client.v2.model.UpdateRuleResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ScorecardsApiapiInstance=newScorecardsApi(defaultClient);// there is a valid "create_scorecard_rule" in the systemStringCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME=System.getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME");StringCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME=System.getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME");StringCREATE_SCORECARD_RULE_DATA_ID=System.getenv("CREATE_SCORECARD_RULE_DATA_ID");UpdateRuleRequestbody=newUpdateRuleRequest().data(newUpdateRuleRequestData().type(RuleType.RULE).attributes(newRuleAttributesRequest().enabled(true).name(CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME).scorecardName(CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME).description("Updated description via test")));try{UpdateRuleResponseresult=apiInstance.updateScorecardRule(CREATE_SCORECARD_RULE_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ScorecardsApi#updateScorecardRule");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update an existing rule returns "Rule updated successfully" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.scorecards_apiimportScorecardsApifromdatadog_api_client.v2.model.rule_attributes_requestimportRuleAttributesRequestfromdatadog_api_client.v2.model.rule_typeimportRuleTypefromdatadog_api_client.v2.model.update_rule_requestimportUpdateRuleRequestfromdatadog_api_client.v2.model.update_rule_request_dataimportUpdateRuleRequestData# there is a valid "create_scorecard_rule" in the systemCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME=environ["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME"]CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME=environ["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME"]CREATE_SCORECARD_RULE_DATA_ID=environ["CREATE_SCORECARD_RULE_DATA_ID"]body=UpdateRuleRequest(data=UpdateRuleRequestData(type=RuleType.RULE,attributes=RuleAttributesRequest(enabled=True,name=CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME,scorecard_name=CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME,description="Updated description via test",),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ScorecardsApi(api_client)response=api_instance.update_scorecard_rule(rule_id=CREATE_SCORECARD_RULE_DATA_ID,body=body)print(response)
# Update an existing rule returns "Rule updated successfully" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ScorecardsAPI.new# there is a valid "create_scorecard_rule" in the systemCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME=ENV["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME"]CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME=ENV["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME"]CREATE_SCORECARD_RULE_DATA_ID=ENV["CREATE_SCORECARD_RULE_DATA_ID"]body=DatadogAPIClient::V2::UpdateRuleRequest.new({data:DatadogAPIClient::V2::UpdateRuleRequestData.new({type:DatadogAPIClient::V2::RuleType::RULE,attributes:DatadogAPIClient::V2::RuleAttributesRequest.new({enabled:true,name:CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME,scorecard_name:CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME,description:"Updated description via test",}),}),})papi_instance.update_scorecard_rule(CREATE_SCORECARD_RULE_DATA_ID,body)
// Update an existing rule returns "Rule updated successfully" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_scorecards::ScorecardsAPI;usedatadog_api_client::datadogV2::model::RuleAttributesRequest;usedatadog_api_client::datadogV2::model::RuleType;usedatadog_api_client::datadogV2::model::UpdateRuleRequest;usedatadog_api_client::datadogV2::model::UpdateRuleRequestData;#[tokio::main]asyncfnmain(){// there is a valid "create_scorecard_rule" in the system
letcreate_scorecard_rule_data_attributes_name=std::env::var("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME").unwrap();letcreate_scorecard_rule_data_attributes_scorecard_name=std::env::var("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME").unwrap();letcreate_scorecard_rule_data_id=std::env::var("CREATE_SCORECARD_RULE_DATA_ID").unwrap();letbody=UpdateRuleRequest::new().data(UpdateRuleRequestData::new().attributes(RuleAttributesRequest::new().description("Updated description via test".to_string()).enabled(true).name(create_scorecard_rule_data_attributes_name.clone()).scorecard_name(create_scorecard_rule_data_attributes_scorecard_name.clone()),).type_(RuleType::RULE),);letconfiguration=datadog::Configuration::new();letapi=ScorecardsAPI::with_config(configuration);letresp=api.update_scorecard_rule(create_scorecard_rule_data_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update an existing rule returns "Rule updated successfully" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ScorecardsApi(configuration);// there is a valid "create_scorecard_rule" in the system
constCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME=process.env.CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAMEasstring;constCREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME=process.env.CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAMEasstring;constCREATE_SCORECARD_RULE_DATA_ID=process.env.CREATE_SCORECARD_RULE_DATA_IDasstring;constparams: v2.ScorecardsApiUpdateScorecardRuleRequest={body:{data:{type:"rule",attributes:{enabled: true,name: CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME,scorecardName: CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME,description:"Updated description via test",},},},ruleId: CREATE_SCORECARD_RULE_DATA_ID,};apiInstance.updateScorecardRule(params).then((data: v2.UpdateRuleResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));