---
id: deployment-group-create
title: "Create deployment group"
description: "Create a new deployment group with multiple deployments."
sidebar_label: "Create deployment group"
hide_title: true
hide_table_of_contents: true
api: eJztWt1v2zgS/1cIPrWF4thJ3G39sEC23bvLPWyLxsUtLgmEsTS2uKVILUnF9Rr63w9DSjZlO03S9vZwi7zY+iA5M7/55FBrnqPNjKic0IpP+BuD4JABU7hkOVZSr0pUji2Mriu2FK5gZS2dqCRGr+3gWvGEO1hYPrnib3fm8ZuE6woNEJGLnE/4dmrqR0wyT5cn3GJWG+FWfHK15jMEg+a8dgWfXN00Nwk3+HuN1v2k8xWfrHmmlUPl6BKqSorMkzj+zZIwa26zAkugK7eqkE+4nv2GmeNhHWEwJ3YNSgSLqch5EnFmie3KEONOoKVVopHbNa0zQi381BjJaYHs4i3Tc+YKZO1M5nQL24AnHD9DWUla4+UPr17zpk99SwGMgdUegXMmhXVEINJTENASnRkyoTJZ55gzoTwXuwolJoTD0t4Hkc101QJknQGHi1V0mebgYB+tzaRHYuXnsWWBBne5nqHUamF74I1OmoirB9GKVuwmshkKtWC1xdyvruqSBBdKOAGSJ3wma0wXBlGRpFvVRc+bXUgOoLrjblrNxaIOnsFoDptrsyt1tygxtgPxUriswDx1BuZzkUUUhXK4QLNPsjaGFq3QZKgcLNDjHuYzHQyFvP8WjSWung2PRsPh8x7mp0NvrJbsI/0KJqZgFug2VCNeOvEjDnqUx0QZSl0rlwplHagMbep0ugThHkD5Q2vVTNXlDA3JvlmGzXCuDbLK6AwxJ3twuuXmM6kBqz4vTcILBOmK1ZaXR6ggIymIg3aRLSd9sJuES6iVx/gxdKbagTwoaLfcnjhBl50mUxI5IjTTWiKoPUIXKqfQi5a81hW4Z8HCdiEIMiducaP5QI+Qrgqw2OPHmRqbpmkS7oTzvrZd8e8Uvt4Fp2qiOVdx2OGjk9OzOGT1vPWAs+5b8unwS3Y+Hn7JFscHreP0sDLHd2AfQLhpmkOGjNaxmc5X3mt8CiUkH528+Z0Ih3KgJcWDMgzaSisbLPBkOKK//RC7yfdsCZbZOsvQ2nktidh3ydptMgJX2520nQQTsHsaTmJyIZvdlfvToFZi1kOQpzPKeHWVb2+6N+CiN+D2E+HjU+ChRL1NOaOQabzoBxbucldnEClUldG3PovtPUtzVALz6BVPONkvDZprE9lowk2tVBgxFwqk+KN3E1ahsVKGF+2NfzEHES6M9q/TGWSf2ltCNNzlKNF1+Eh0mBOcfaguveR3QnWtrtWP7MWLX7TDFy8m7BKRXW1LUnvz7DjXmT2OtP3cO1BJsV+ouTalt5DBtfrR17Vb5DsA7i3Vnqqqp6rqqap6qqr+j6uqZpNHHxHevjXxfU2UUlDiw+jQyI0veFL9xHr+gR2xSwcLH+MjiPzYt32cAkJPkekpMj1Fpu8Zmfaq9EeGkGj2wQKxCyTM6cNNuG/v8oG1OhO0Hwi7rj4bfarjlz+82qknu83H/Rr/ZaPraHoHfei97ig82s48SLjaookk9NO1edA+5fXrUdPbMn0NQQnWxy5LO8lCs3a5h1A/aXp7tAPUQ6lPKRAcHjlR4mEFX747evVyOGIfp28YjbIOyoo4XBZ4h5HRrrcl3tf3yfDk9Gg0PBqOpqOTyenZZPzy37zpbSD/fE49yi0HD2H37urhQ9sdaJsFZ7/+ut8feCMFkUdjtGGbdgLLa98fF+oWpKCedVU7RvsyYa2PGGCgRIfGfrcmQthEv9E5wen54Qkv0VpY4IGt13b0/a75j+n0PQszWKZzCg6VQYvK92h8AVJhJigoZjEez3CwGCTsbDiknxH9nNLPWT8jnw0pMWZ9Xu5wq3NWAgVdPDIIOcwktrQ8X64AxyiaL7QRf6ANvKG5RcNo016bnSppBnlqupZQB9sDmJgZgfOEFXUJastJNKrz+cAcLdehcc1/gpy1fahrTg8+Kqhd4VnOr3kfnHg0sdhp9H4m81zQJUiWowMhLYOZrt2WrT6dqQ/6oRFHflSCJE/FnHl0lQOh/PFLMOnYgpsmeMj4kIdcBvh3PUSEvOubfIoJa2vsKrjz9xfMihz/Yq5hYyBaYxiTa4yHJ/Rz+nynWvyfeQUJaxTINAxKA2R/mn9ctORZazo/05jgKfREZMg+KrgFIWnVPYc5OP2/6jrnitUKP1eYUToPIukso1I5H7D37XGpWTFYgFBMgkPTeY3nyxWaevyVtn7jCXRIzKOuXtrVP0Eh1h8O1EbyCS+cq+zk+BgqMVC1lJUER347yHTJ6Zi5O4W+JFcJFh6fRW+woIV8v5mGUWj0g6iv5S/+1mXtf/5r6pMmueCH7RH2zx0a/aPlUInutBj/sicbCaeeKzHZ7v9IvMFwMIyOJaL2LRkl6bwEH8zC5r/7bmG3uNm10uiLgW/81CHo3+Fnd1xJEL5N6Y1r3Zri1d5HDhQ1C7LWyRVfr2dg8aORTUOPf6/R0CcPNwm/BSPIRf0XDx7nHI1X/ydchRYCCXA0JQ5ouKx9Z2Y30DdJN+M8y7ByXxx7EznU+3eXU7Lg9hOL0gdTbmBJCQKWfMI5fc5Bs8NHEfRszSWoRe0jBQ9r+p1c31123MNL1XWW1CricL0OI6b6E6qm4UkriqN7TsdhzX8AmR005A==
sidebar_class_name: "post 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={"Create deployment group"}
>
</Heading>

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



Create a new deployment group with multiple deployments.


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

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["release_id","deployments"],"properties":{"release_id":{"type":"string","description":"The ID of the release to deploy.","example":"6789"},"deployments":{"type":"array","description":"A list of deployment objects to be included in the deployment group.","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"},"example":[{"scope_id":"1234","strategy":"blue_green","strategy_data":{"switched_traffic":30,"desired_switched_traffic":50,"amount_instances_to_wait":5,"healthy_instances":3,"launched_instances":5,"switch_traffic_step":true}}]}},"description":"Request body for creating a new deployment group with multiple deployments.","title":"deploymentGroupCreateRequest"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"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>