---
id: deployment-group-update
title: "Update deployment group"
description: "Updates a deployment group's status or strategy data."
sidebar_label: "Update deployment group"
hide_title: true
hide_table_of_contents: true
api: eJztWVtz27YS/isYvDTJ0LJkW2mih864Tk/rPrQZW552ans4K2IloiEBFgCtqBr+984CpESKii9pm3PmjF8kggSwF+x+i91dc4E2MbJwUis+4VeFAIeWARNYZHqVo3JsYXRZfGWZdeBKy7Rh1hlwuFgxAQ4GN4pH3MHC8sk1f7ezjt9GXBdogCicCz7h251jP2NSeqI84haT0ki34pPrNZ8hGDSnpUv55Pq2uo14AQZydGisn6AgRz7hUvCIS2K+AJfyaEeiaYrs/B3Tc+ZS7EnFnGaB/IBH3OAfpTQo+MSZEiNukxRz4JM1d6uCaFlnpFrwKuL4EfIio3cjTrzRUrTuWy1WND/RyqFy9AhFkcnEi3/4uyWe1v2N9ex3TByPeGFIWU6i9fO8xvsM7Ap5WZ/MfiEHN+pGfcNevfpJO3z1asIuEdn19qDs7YtDoRN7uF1oX7K5NizXBplUc21yL8DgRn3jT3srvimVqnXSWEVMVrFPuC7TZ1rN5aIMluEtydPckaDZdNBXzlK6JEUROwPzuUxaFKVyuEDTJ1kaQ5sWaBJUDhbodRbWM608cYVLdofGElcvhgej4fDloC3y8bDy+5KlxJ/BxBTMAt2GaouXRvwWBx3KY6IMuS6Vi6WyDlSCNnY6XoJ0j6B8Uds3U2U+Q0Oyb7ZhM5zTaRdGJ4hCqgX5RuDmIx0DFl1eqoinCJlLV1tennAECUlBHNSbbDnpKruKeAal8jp+Cp2pdpDtFbTZridOOMvmJGMSuUVopnWGoHqEzpUg90bLlim6FHsWLC2TwbIgcfIONycf6JGmixQsdvghAKqqqoq4k8472nbH78mpA1JfBNjhYapBW2hlg36OhkP666PhBo3ZEiyzZZKgtfMyI/qfjVtb6LwOiFxDV9Tim0Y20QX6hw5YRG1ysd/AYIZgMQxam8TBAYhZg+BQxLMVj3hA8XrQfAHX+gKOYlEXQ6R4GFzvjyCdU6NgEN2D2qjKnDTk+ZNqEUNRGH0HWcNz+10sUEkUrU884uTpNGmuTcsdog0MR3wuFWTyz84g7EJzsyx8qAf+wxxkeDDaf45nkHyoh6TRMBKYoWv0k6FDQer8X4xDbYvbHgIYA2Qb0mFuHzJhb6ZxbcjBUHs22zOmzaInmpRfR+hhcFdvM8y0WnQhcXTUirWPo7UnnrIZEvKUtgbC2jKlkk56e5xlJcYLg6hI0q2iW++fY/5zzH+O+V8u5v8cnIpm1HH0CfD2dwPf56BUSNEeQ4dmbnzBk+oG1tMLdsAuHSw8xrdU5Oe+6+opaOgZmZ6R6RmZ/klk6t3SnwghrdX7qzE1kDCnu97/+us3b3nVyQmeSLpeycBanUjKB9hSunSHjS7V8euv3+zcJ5vk4+ET/2lz1q3ljepDZWznwFvpzKOEKy2aloR+uTaPylPevh1VnZTpcwhmYD12Wcok06aOJh5D/ajq5Gh7qIerPoVAcHjgZI77D/jy54M3r4cjdjU9YzTLOsgL4nCZ4ieMjLLemnj3vI+GR8cHo+HBcDQdHU2OTybj17/xqpNAfnlOvZZrDh7D7qdvDxd1daAuFpz8+mu/PnCWSSKPxmjDNuUEJkok/JXqDjIpmFRF6agOnEtrPWJsKrP/WBEhJNFnWpA6PT884jlaCwvck3ptZz/smj9Mp++bYnaiBYFDYdCicj7O0AWkwEQSKCZtfbzAwWIQsZPhkH5G9HNMPyfdiHwypMCYdHn5hFudshwIdPHAIAiYZVjT8ny5FBwjNF9oI/9EG3hDc4eGUdJemp1b0gxEbJqSUKO2RzAxMxLnEUvLHNSWk9asxucDc7Rdo40b/i0IVtehbji9uFJQutSzLG54Vznt2cRic6IPMymEpEfImEAHMrMMZrp0W7a6dKYe9D0d70c5ZOSpKJjXrnIgFYqNSbctuKqCh4z3echlUP+uh8gQd8mAQDFpbYnNDe70/TmzUuD/mWvYtiJqYxiTa4yHR/Rz/HLntvhf8woS1ijI4jApDir7Yv5xXpNntel8R3OCp9AbmSC7UnAHMqNdew6zd/m/6jqnipUKPxaYUDgPIukkoauyGLD34SLlzIrBAqRiGTg0jdd4vlyqRejHJdSQ8325CT/cbfwdrqWofNuPBAtNvdJkfMJT5wo7OTyEQg5UmWVFBo68d5Do3Lfbmk7hJTlMsPN2v3CjEdqI1408D5B+ElW3/MN/mtj94y9THzrJES+2rbzvGp1sW3GtSmsvw+ynX8fD+5Kz8fC+BGq8N6U53p+BjD+RMISbOzVI55pYrBM5KlUPhoMh394WWnVYsq5CW5eDR6W60Ro6Dr1byq65tZqff6edHM7P4Ud3WGQgfbHRG8e6tqfrXiOZR3wifVU61dbRjPV6BhavTFZV9PqPEg01l28jfgdGkrt5oxPS0rPgkzlkFu8R6EWTtL5kT2ks75WmKdwoKtvcQVbSiEf8A65CW7u6DVmtQOPZDB/OAjMHU1q+XdgLJ1XUrDhNEizcvXNvW277/nR69gO5SN3Lzj1mcwNLikOwDFxqrx3vef7dmmegFqUHJB429Qlj1x93/M+LtVcP63WYMdUfUFXVRi2OxqSZqvoLvSV7lg==
sidebar_class_name: "patch api-method"
info_path: docs/api/deployments
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update deployment group"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/deployment_group/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates a deployment group's status or strategy data.


<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","description":"The ID of the deployment group to update.","required":true,"schema":{"type":"string"},"example":"1"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the deployment group.\n\n> **Note**: See [Deployments](/docs/deployments) for more information.\n>\n","example":"running"},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}}},"title":"deploymentGroupUpdateRequest"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","status","deployments","scopes","strategy_data","application_id","release_id","deployments_amount","created_by","updated_by","created_at","updated_at"],"properties":{"id":{"type":"string","description":"The ID of the deployment group.","example":"1"},"status":{"type":"string","enum":["creating_approval","creating_approval_denied","creating","waiting_for_instances","running","finalizing","finalized","cancelling","cancelled","failed","rolling_back","rolled_back","deleting","deleted"],"description":"Status of the deployment group.\n\n> **Note**: See [Deployments](/docs/deployments) for more information.\n>\n","example":"running"},"deployments":{"type":"array","items":{"type":"object","required":["scope_id","strategy","strategy_data"],"properties":{"scope_id":{"type":"string","description":"The ID of the scope where the deployment belongs.","example":12},"strategy":{"type":"string","description":"The deployment strategy being used.","enum":["initial","blue_green"],"example":"blue_green"},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}}},"title":"deploymentGroupObject"}},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the scope where the deployment belongs.","example":12},"name":{"type":"string","description":"The name for the scope.","example":"AR - Staging"}},"title":"scopeDeploymentGroup"}},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}},"application_id":{"type":"string","description":"The ID of the application the deployment group belongs to.","example":"6789"},"release_id":{"type":"string","description":"The ID of the release associated with the deployment.","example":"5678"},"deployments_amount":{"type":"integer","description":"Number of deployments in the group","example":5},"created_by":{"type":"string","description":"The user ID of the creator of the deployment group.","example":991},"updated_by":{"type":"string","description":"The user ID of the last person who updated the deployment group.","example":992},"created_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the deployment group was created.","example":"2023-10-01T12:34:56Z"},"updated_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the deployment group was last updated.","example":"2023-10-01T12:34:56Z"}},"title":"deploymentGroupResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>