--- title: Update an existing scorecard rule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Scorecards --- {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Update an existing scorecard rule{% #update-an-existing-scorecard-rule %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------ | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/scorecard/rules/{rule_id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/scorecard/rules/{rule_id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/scorecard/rules/{rule_id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/scorecard/rules/{rule_id} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v2/scorecard/rules/{rule_id} | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/scorecard/rules/{rule_id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/scorecard/rules/{rule_id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/scorecard/rules/{rule_id} | ### Overview Updates an existing rule. OAuth apps require the `apm_service_catalog_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#scorecards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------- | ------ | ------------------- | | rule_id [*required*] | string | The ID of the rule. | ### Request #### Body Data (required) Rule attributes. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | | data | object | Data for the request to update a scorecard rule. | | data | attributes | object | Attributes for creating or updating a rule. Server-managed fields (created_at, modified_at, custom) are excluded. | | attributes | description | string | Explanation of the rule. | | attributes | enabled | boolean | If enabled, the rule is calculated as part of the score. | | attributes | level | int32 | The maturity level of the rule (1, 2, or 3). | | attributes | name | string | Name of the rule. | | attributes | owner | string | Owner of the rule. | | attributes | scope_query | string | A query to filter which entities this rule applies to. | | attributes | scorecard_name | string | The scorecard name to which this rule must belong. | | data | type | enum | The JSON:API type for scorecard rules. Allowed enum values: `rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "type": "rule", "attributes": { "enabled": true, "name": "Team Defined", "scorecard_name": "Deployments automated via Deployment Trains", "description": "Updated description via test" } } } ``` {% /tab %} ### Response {% tab title="200" %} Rule updated successfully {% tab title="Model" %} The response from a rule update request. | Parent field | Field | Type | Description | | ------------- | -------------- | --------- | ------------------------------------------------------------------ | | | data | object | The data for a rule update response. | | data | attributes | object | Details of a rule. | | attributes | category | string | **DEPRECATED**: The scorecard name to which this rule must belong. | | attributes | created_at | date-time | Creation time of the rule outcome. | | attributes | custom | boolean | Defines if the rule is a custom rule. | | attributes | description | string | Explanation of the rule. | | attributes | enabled | boolean | If enabled, the rule is calculated as part of the score. | | attributes | level | int32 | The maturity level of the rule (1, 2, or 3). | | attributes | modified_at | date-time | Time of the last rule outcome modification. | | attributes | name | string | Name of the rule. | | attributes | owner | string | Owner of the rule. | | attributes | scope_query | string | A query to filter which entities this rule applies to. | | attributes | scorecard_name | string | The scorecard name to which this rule must belong. | | data | id | string | The unique ID for a scorecard rule. | | data | relationships | object | Scorecard create rule response relationship. | | relationships | scorecard | object | Relationship data for a rule. | | scorecard | data | object | Rule relationship data. | | data | id | string | The unique ID for a scorecard. | | data | type | enum | The JSON:API type for scorecard. Allowed enum values: `scorecard` | | data | type | enum | The JSON:API type for scorecard rules. Allowed enum values: `rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "category": "string", "created_at": "2019-09-19T10:00:00.000Z", "custom": false, "description": "string", "enabled": true, "level": 2, "modified_at": "2019-09-19T10:00:00.000Z", "name": "Team Defined", "owner": "string", "scope_query": "kind:service", "scorecard_name": "Deployments automated via Deployment Trains" }, "id": "q8MQxk8TCqrHnWkx", "relationships": { "scorecard": { "data": { "id": "q8MQxk8TCqrHnWkp", "type": "scorecard" } } }, "type": "rule" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export rule_id="CHANGE_ME" \# Curl command curl -X PUT "https://api.datadoghq.com/api/v2/scorecard/rules/${rule_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "description": "Updated Description", "enabled": false, "name": "Updated Rule", "owner": "team:updated-team", "scope_query": "kind:service", "scorecard_name": "Updated Scorecard" }, "type": "rule" } } EOF ##### ```go // Update an existing rule returns "Rule updated successfully" response package main import ( "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" ) func main() { // there is a valid "create_scorecard_rule" in the system CreateScorecardRuleDataAttributesName := 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) if err != 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) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update an existing rule returns "Rule updated successfully" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ScorecardsApi; import com.datadog.api.client.v2.model.RuleAttributesRequest; import com.datadog.api.client.v2.model.RuleType; import com.datadog.api.client.v2.model.UpdateRuleRequest; import com.datadog.api.client.v2.model.UpdateRuleRequestData; import com.datadog.api.client.v2.model.UpdateRuleResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ScorecardsApi apiInstance = new ScorecardsApi(defaultClient); // there is a valid "create_scorecard_rule" in the system String CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME = System.getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME"); String CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME = System.getenv("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME"); String CREATE_SCORECARD_RULE_DATA_ID = System.getenv("CREATE_SCORECARD_RULE_DATA_ID"); UpdateRuleRequest body = new UpdateRuleRequest() .data( new UpdateRuleRequestData() .type(RuleType.RULE) .attributes( new RuleAttributesRequest() .enabled(true) .name(CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME) .scorecardName(CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME) .description("Updated description via test"))); try { UpdateRuleResponse result = apiInstance.updateScorecardRule(CREATE_SCORECARD_RULE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { 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(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Update an existing rule returns "Rule updated successfully" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.scorecards_api import ScorecardsApi from datadog_api_client.v2.model.rule_attributes_request import RuleAttributesRequest from datadog_api_client.v2.model.rule_type import RuleType from datadog_api_client.v2.model.update_rule_request import UpdateRuleRequest from datadog_api_client.v2.model.update_rule_request_data import UpdateRuleRequestData # there is a valid "create_scorecard_rule" in the system CREATE_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() with ApiClient(configuration) as api_client: api_instance = ScorecardsApi(api_client) response = api_instance.update_scorecard_rule(rule_id=CREATE_SCORECARD_RULE_DATA_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update an existing rule returns "Rule updated successfully" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ScorecardsAPI.new # there is a valid "create_scorecard_rule" in the system CREATE_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", }), }), }) p api_instance.update_scorecard_rule(CREATE_SCORECARD_RULE_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Update an existing rule returns "Rule updated successfully" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_scorecards::ScorecardsAPI; use datadog_api_client::datadogV2::model::RuleAttributesRequest; use datadog_api_client::datadogV2::model::RuleType; use datadog_api_client::datadogV2::model::UpdateRuleRequest; use datadog_api_client::datadogV2::model::UpdateRuleRequestData; #[tokio::main] async fn main() { // there is a valid "create_scorecard_rule" in the system let create_scorecard_rule_data_attributes_name = std::env::var("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME").unwrap(); let create_scorecard_rule_data_attributes_scorecard_name = std::env::var("CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME").unwrap(); let create_scorecard_rule_data_id = std::env::var("CREATE_SCORECARD_RULE_DATA_ID").unwrap(); let body = 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), ); let configuration = datadog::Configuration::new(); let api = ScorecardsAPI::with_config(configuration); let resp = api .update_scorecard_rule(create_scorecard_rule_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update an existing rule returns "Rule updated successfully" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ScorecardsApi(configuration); // there is a valid "create_scorecard_rule" in the system const CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME = process.env .CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME as string; const CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME = process.env .CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME as string; const CREATE_SCORECARD_RULE_DATA_ID = process.env .CREATE_SCORECARD_RULE_DATA_ID as string; const params: 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)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}