--- title: Update deployment rule description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Deployment Gates --- # Update deployment rule{% #update-deployment-rule %} {% tab title="v2" %} **Note**: This endpoint is in preview and may be subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------ | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/deployment_gates/{gate_id}/rules/{id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/deployment_gates/{gate_id}/rules/{id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/deployment_gates/{gate_id}/rules/{id} | ### Overview Endpoint to update a deployment rule. This endpoint requires the `deployment_gates_write` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------- | ------ | ------------------------------ | | gate_id [*required*] | string | The ID of the deployment gate. | | id [*required*] | string | The ID of the deployment rule. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | -------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Parameters for updating a deployment rule. | | data | attributes [*required*] | object | Parameters for updating a deployment rule. | | attributes | dry_run [*required*] | boolean | Whether to run this rule in dry-run mode. | | attributes | name [*required*] | string | The name of the deployment rule. | | attributes | options [*required*] | | Options for deployment rule response representing either faulty deployment detection or monitor options. | | options | Option 1 | object | Faulty deployment detection options for deployment rules. | | Option 1 | duration | int64 | The duration for faulty deployment detection. | | Option 1 | excluded_resources | [string] | Resources to exclude from faulty deployment detection. | | options | Option 2 | object | Monitor options for deployment rules. | | Option 2 | duration | int64 | Seconds the monitor needs to stay in OK status for the rule to pass. | | Option 2 | query [*required*] | string | Monitors that match this query are evaluated. | | data | type [*required*] | enum | Deployment rule resource type. Allowed enum values: `deployment_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "dry_run": false, "name": "Updated deployment rule", "options": { "excluded_resources": [] } }, "type": "deployment_rule" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response for a deployment rule. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | -------------------------------------------------------------------------------------------------------- | | | data | object | Data for a deployment rule. | | data | attributes [*required*] | object | Basic information about a deployment rule. | | attributes | created_at [*required*] | date-time | The timestamp when the deployment rule was created. | | attributes | created_by [*required*] | object | Information about the user who created the deployment rule. | | created_by | handle | string | The handle of the user who created the deployment rule. | | created_by | id [*required*] | string | The ID of the user who created the deployment rule. | | created_by | name | string | The name of the user who created the deployment rule. | | attributes | dry_run [*required*] | boolean | Whether this rule is run in dry-run mode. | | attributes | gate_id [*required*] | string | The ID of the deployment gate. | | attributes | name [*required*] | string | The name of the deployment rule. | | attributes | options [*required*] | | Options for deployment rule response representing either faulty deployment detection or monitor options. | | options | Option 1 | object | Faulty deployment detection options for deployment rules. | | Option 1 | duration | int64 | The duration for faulty deployment detection. | | Option 1 | excluded_resources | [string] | Resources to exclude from faulty deployment detection. | | options | Option 2 | object | Monitor options for deployment rules. | | Option 2 | duration | int64 | Seconds the monitor needs to stay in OK status for the rule to pass. | | Option 2 | query [*required*] | string | Monitors that match this query are evaluated. | | attributes | type [*required*] | enum | The type of the deployment rule. Allowed enum values: `faulty_deployment_detection,monitor` | | attributes | updated_at | date-time | The timestamp when the deployment rule was last updated. | | attributes | updated_by | object | Information about the user who updated the deployment rule. | | updated_by | handle | string | The handle of the user who updated the deployment rule. | | updated_by | id [*required*] | string | The ID of the user who updated the deployment rule. | | updated_by | name | string | The name of the user who updated the deployment rule. | | data | id [*required*] | string | Unique identifier of the deployment rule. | | data | type [*required*] | enum | Deployment rule resource type. Allowed enum values: `deployment_rule` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "created_at": "2021-01-01T00:00:00Z", "created_by": { "handle": "test-user", "id": "1111-2222-3333-4444-555566667777", "name": "Test User" }, "dry_run": false, "gate_id": "1111-2222-3333-4444-555566667777", "name": "My deployment rule", "options": { "duration": 3600, "excluded_resources": [ "resource1", "resource2" ] }, "type": "faulty_deployment_detection", "updated_at": "2019-09-19T10:00:00.000Z", "updated_by": { "handle": "test-user", "id": "1111-2222-3333-4444-555566667777", "name": "Test User" } }, "id": "1111-2222-3333-4444-555566667777", "type": "deployment_rule" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad request. {% tab title="Model" %} Bad request. | Parent field | Field | Type | Description | | ------------ | ------ | -------- | ------------------ | | | errors | [object] | Structured errors. | | errors | detail | string | Error message. | | errors | status | string | Error code. | | errors | title | string | Error title. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Malformed payload", "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% 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="404" %} Deployment rule not found. {% tab title="Model" %} Deployment rule not found. | Parent field | Field | Type | Description | | ------------ | ------ | -------- | ------------------ | | | errors | [object] | Structured errors. | | errors | detail | string | Error message. | | errors | status | string | Error code. | | errors | title | string | Error title. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Malformed payload", "status": "400", "title": "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 %} {% tab title="500" %} Internal Server Error {% tab title="Model" %} Errors occurred. | Parent field | Field | Type | Description | | ------------ | ------ | -------- | ------------------ | | | errors | [object] | Structured errors. | | errors | detail | string | Error message. | | errors | status | string | Error code. | | errors | title | string | Error title. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Malformed payload", "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export gate_id="CHANGE_ME" export id="CHANGE_ME" \# Curl command curl -X PUT "https://api.datadoghq.com/api/v2/deployment_gates/${gate_id}/rules/${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": { "dry_run": false, "name": "Updated deployment rule", "options": [ "resource1", "resource2" ] }, "type": "deployment_rule" } } EOF ##### ```go // Update deployment rule returns "OK" 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 "deployment_gate" in the system DeploymentGateDataID := os.Getenv("DEPLOYMENT_GATE_DATA_ID") // there is a valid "deployment_rule" in the system DeploymentRuleDataID := os.Getenv("DEPLOYMENT_RULE_DATA_ID") body := datadogV2.UpdateDeploymentRuleParams{ Data: datadogV2.UpdateDeploymentRuleParamsData{ Attributes: datadogV2.UpdateDeploymentRuleParamsDataAttributes{ DryRun: false, Name: "Updated deployment rule", Options: datadogV2.DeploymentRulesOptions{ DeploymentRuleOptionsFaultyDeploymentDetection: &datadogV2.DeploymentRuleOptionsFaultyDeploymentDetection{ ExcludedResources: []string{}, }}, }, Type: datadogV2.DEPLOYMENTRULEDATATYPE_DEPLOYMENT_RULE, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.UpdateDeploymentRule", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewDeploymentGatesApi(apiClient) resp, r, err := api.UpdateDeploymentRule(ctx, DeploymentGateDataID, DeploymentRuleDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DeploymentGatesApi.UpdateDeploymentRule`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DeploymentGatesApi.UpdateDeploymentRule`:\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 deployment rule returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.DeploymentGatesApi; import com.datadog.api.client.v2.model.DeploymentRuleDataType; import com.datadog.api.client.v2.model.DeploymentRuleOptionsFaultyDeploymentDetection; import com.datadog.api.client.v2.model.DeploymentRuleResponse; import com.datadog.api.client.v2.model.DeploymentRulesOptions; import com.datadog.api.client.v2.model.UpdateDeploymentRuleParams; import com.datadog.api.client.v2.model.UpdateDeploymentRuleParamsData; import com.datadog.api.client.v2.model.UpdateDeploymentRuleParamsDataAttributes; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.updateDeploymentRule", true); DeploymentGatesApi apiInstance = new DeploymentGatesApi(defaultClient); // there is a valid "deployment_gate" in the system String DEPLOYMENT_GATE_DATA_ID = System.getenv("DEPLOYMENT_GATE_DATA_ID"); // there is a valid "deployment_rule" in the system String DEPLOYMENT_RULE_DATA_ID = System.getenv("DEPLOYMENT_RULE_DATA_ID"); UpdateDeploymentRuleParams body = new UpdateDeploymentRuleParams() .data( new UpdateDeploymentRuleParamsData() .attributes( new UpdateDeploymentRuleParamsDataAttributes() .dryRun(false) .name("Updated deployment rule") .options( new DeploymentRulesOptions( new DeploymentRuleOptionsFaultyDeploymentDetection()))) .type(DeploymentRuleDataType.DEPLOYMENT_RULE)); try { DeploymentRuleResponse result = apiInstance.updateDeploymentRule(DEPLOYMENT_GATE_DATA_ID, DEPLOYMENT_RULE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DeploymentGatesApi#updateDeploymentRule"); 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 deployment rule returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.deployment_gates_api import DeploymentGatesApi from datadog_api_client.v2.model.deployment_rule_data_type import DeploymentRuleDataType from datadog_api_client.v2.model.deployment_rule_options_faulty_deployment_detection import ( DeploymentRuleOptionsFaultyDeploymentDetection, ) from datadog_api_client.v2.model.update_deployment_rule_params import UpdateDeploymentRuleParams from datadog_api_client.v2.model.update_deployment_rule_params_data import UpdateDeploymentRuleParamsData from datadog_api_client.v2.model.update_deployment_rule_params_data_attributes import ( UpdateDeploymentRuleParamsDataAttributes, ) # there is a valid "deployment_gate" in the system DEPLOYMENT_GATE_DATA_ID = environ["DEPLOYMENT_GATE_DATA_ID"] # there is a valid "deployment_rule" in the system DEPLOYMENT_RULE_DATA_ID = environ["DEPLOYMENT_RULE_DATA_ID"] body = UpdateDeploymentRuleParams( data=UpdateDeploymentRuleParamsData( attributes=UpdateDeploymentRuleParamsDataAttributes( dry_run=False, name="Updated deployment rule", options=DeploymentRuleOptionsFaultyDeploymentDetection( excluded_resources=[], ), ), type=DeploymentRuleDataType.DEPLOYMENT_RULE, ), ) configuration = Configuration() configuration.unstable_operations["update_deployment_rule"] = True with ApiClient(configuration) as api_client: api_instance = DeploymentGatesApi(api_client) response = api_instance.update_deployment_rule( gate_id=DEPLOYMENT_GATE_DATA_ID, id=DEPLOYMENT_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 deployment rule returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.update_deployment_rule".to_sym] = true end api_instance = DatadogAPIClient::V2::DeploymentGatesAPI.new # there is a valid "deployment_gate" in the system DEPLOYMENT_GATE_DATA_ID = ENV["DEPLOYMENT_GATE_DATA_ID"] # there is a valid "deployment_rule" in the system DEPLOYMENT_RULE_DATA_ID = ENV["DEPLOYMENT_RULE_DATA_ID"] body = DatadogAPIClient::V2::UpdateDeploymentRuleParams.new({ data: DatadogAPIClient::V2::UpdateDeploymentRuleParamsData.new({ attributes: DatadogAPIClient::V2::UpdateDeploymentRuleParamsDataAttributes.new({ dry_run: false, name: "Updated deployment rule", options: DatadogAPIClient::V2::DeploymentRuleOptionsFaultyDeploymentDetection.new({ excluded_resources: [], }), }), type: DatadogAPIClient::V2::DeploymentRuleDataType::DEPLOYMENT_RULE, }), }) p api_instance.update_deployment_rule(DEPLOYMENT_GATE_DATA_ID, DEPLOYMENT_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 deployment rule returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_deployment_gates::DeploymentGatesAPI; use datadog_api_client::datadogV2::model::DeploymentRuleDataType; use datadog_api_client::datadogV2::model::DeploymentRuleOptionsFaultyDeploymentDetection; use datadog_api_client::datadogV2::model::DeploymentRulesOptions; use datadog_api_client::datadogV2::model::UpdateDeploymentRuleParams; use datadog_api_client::datadogV2::model::UpdateDeploymentRuleParamsData; use datadog_api_client::datadogV2::model::UpdateDeploymentRuleParamsDataAttributes; #[tokio::main] async fn main() { // there is a valid "deployment_gate" in the system let deployment_gate_data_id = std::env::var("DEPLOYMENT_GATE_DATA_ID").unwrap(); // there is a valid "deployment_rule" in the system let deployment_rule_data_id = std::env::var("DEPLOYMENT_RULE_DATA_ID").unwrap(); let body = UpdateDeploymentRuleParams::new(UpdateDeploymentRuleParamsData::new( UpdateDeploymentRuleParamsDataAttributes::new( false, "Updated deployment rule".to_string(), DeploymentRulesOptions::DeploymentRuleOptionsFaultyDeploymentDetection(Box::new( DeploymentRuleOptionsFaultyDeploymentDetection::new().excluded_resources(vec![]), )), ), DeploymentRuleDataType::DEPLOYMENT_RULE, )); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.UpdateDeploymentRule", true); let api = DeploymentGatesAPI::with_config(configuration); let resp = api .update_deployment_rule( deployment_gate_data_id.clone(), deployment_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 deployment rule returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.updateDeploymentRule"] = true; const apiInstance = new v2.DeploymentGatesApi(configuration); // there is a valid "deployment_gate" in the system const DEPLOYMENT_GATE_DATA_ID = process.env.DEPLOYMENT_GATE_DATA_ID as string; // there is a valid "deployment_rule" in the system const DEPLOYMENT_RULE_DATA_ID = process.env.DEPLOYMENT_RULE_DATA_ID as string; const params: v2.DeploymentGatesApiUpdateDeploymentRuleRequest = { body: { data: { attributes: { dryRun: false, name: "Updated deployment rule", options: { excludedResources: [], }, }, type: "deployment_rule", }, }, gateId: DEPLOYMENT_GATE_DATA_ID, id: DEPLOYMENT_RULE_DATA_ID, }; apiInstance .updateDeploymentRule(params) .then((data: v2.DeploymentRuleResponse) => { 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 %}