---
id: deployment-group-read
title: "Read deployment group"
description: "Retrieves information about a specific deployment group."
sidebar_label: "Read deployment group"
hide_title: true
hide_table_of_contents: true
api: eJztWVuP27YS/isEn5JA6/Xe0sQPBfYkPT17Htpg18Epzu5CGItji41EquTIm62h/14MKdmS7TTe9HKAg7zYupCcb765kDNaSYU+c7oibY2cyGskp3GJXmgzt64Efi5gZmsSIHyFmZ7rTCisCvtYoiGxcLauRndGJpJg4eXkVr7deivvE2krdGGxKyUncjM/DSMmDkHJRHrMaqfpUU5uV3KG4NBd1pTLye19c5/IChyUSOh8GGCgRDmRmmdqRl8B5TLZUmmao7h6K+xcUI47yAVZwcJHMpEOf6m1QyUn5GpMpM9yLEFOVpIeK5bkyWmzkE0i8SOUVcHPTiQjc+grazx6Hn06HvPfLow1CeIBvPB1lqH387pg4Zk1hIZ4IlRVobMw8Phnz7NXu1js7GfMaID6NlLhCaj2gYdOV77zma0wXJADwsVjqoBAJn1xaVjAYYHgMd70FkmhtLVhmZlDIFTp7FEmsq7U5qZ7A9R7A8QuUDnWn3QkSatdYp9mOmZtYIe16nsWRlOXzFDAp80ihapydglFh7n/LFVoNKreK5nIB9Bh0Ny6VBtPYLJAp6uNiSPm2kChfx3cxFV4bFHEF+1NeDEHHS+cDa/TGWQf2ltmNN4pLJA6fgokVEznkKqboPknqbozd+Zb8eLFD5bwxYuJuEEUt5s49ffPjpXN/HHP2s/F3DpRWof9XDC6M9+GYN8w3xHQDD1uYwRwDtg3NGHpP+fCwU3T1pGjo+747I4zrSc90aXCPPGQo8Nt3mZYWLPwAyc7OW16qA6S1VuxmyhmqM1C1B5D1uk8UxtNOvjjrKgxXThEw5puiO49b7Yp2cPqEMwba+Z6Ubf5h+cE+9J+jAxsi+IHTVmOKiUH87nOehK1IVyg2xVZO8eLVugyNAQLDLzH+cKaINzgg1ii84zq2fjoZDx+PuD8bBz8yrN/pF8AYgpugbSW2sPSqd9DMJB8wZJjytsEfEo25UxwgOTr1quFqcsZOtZ9vYyY4Zwjq3I2Q1TsD2RbNB/ZDDhMbxdNInOEgvLHXvI53AQZa8EI2kU2SIZkN4ksoDaB46fImVqCYq+i3XI76kRbdpZMWeWeoJm1BYLZEXRlFO9V6DlqKccdD9Z8dAkPISO9xLXlozxmusrB4wAP7/dN0zSJJE0h1jYrfs8J9McYVDyi3UefkN7+6Mb3JVkqno0OkcMj17EQRA031strcSRuCBYhx/coCmPfDnmKDH3NTF8z09fM9Gdmpp1T+hNTSG/2/jKoTSSC7DD6X37z6jWfNno1wRNFtzMFeG8zzfWAeNCUb8EYSr14+c2rrfNkV3x83uI/rG3dm95RHwvSLYP3ypmDlKs9up6GYbp1B9Upr1+fNIOS6UsEFuBD7vJcSeZWtMsdIv20GdRoe6THoz5vgUB4RLrE/Qa++fHo1cvxiXg/fSN4lCcoK0b4kOMnnIyr3lb40N6n49Ozo5Px0fhkenI6OTufXLz8r2wGBeTfjzSw3CI4BO6nTw/XbXdAxjPG+U8/7fYH3hSaxaNz1ol1O0GoGjn/arOEQiuhTVWT4LpMex8yxrol8qc1EWIR/cYqpjPgkYks0XtY4J7SazP686H5r+n0nYgzRGYVJ4fKoUdDYZ/hA0jXYsr6fDzD0WKUiPPxmH9O+OeMf86HO/L5mDfGbIjlE2F1KUrgpItH3P6BWYGtrICLciDB2Xxhnf4VfcSGbolOcNFeu61T0gxUyiSip9AfCrQdAGLmNM4TkdclmA2S3qgu5iM4Xq5j407+A5S4jkLvJD94b6CmPEBWd3JITn80Q+ws+nmQSmm+hEIoJNCFbxuCa1hDOdOQ9IOcEEclFBypqERg1xBog2rt0n0PbpoYIRf7IuQm0r8dITruu+xAYIT2vsbuBHf57kp4rfD/LDR8n4jWGS44NC7Gp/xz9nzrtPg/iwpW1hko0jgojZT9bfFx1YoXret8x2NipPATnaF4b2AJuuBVdwJm7/S/NHQujagNfqww4+08qmSzjI/KaiTexYMUuUcBC9BGFEDouqgJuCi33F9fYKg7uR0+kcfb3fbjlVZN6LazWrGXXrtCTmROVPnJ8TFUemTqoqgKII7dUWbL0OfuGvQ3HC7Ry/tt+jUfvJBsO+ghPYZB3NsKF//sdu5//2caNk7uMPL0ttrhfu5oPBrLzZbaa1ayCSrrqYQQuu1ngGsEtbORb1tktckDf/BbR9ST8CMdVwXo0JILJK5a3m93vnLIRE506N3m1hOPWK1m4PG9K5qGH/9So+NvH/eJXILT7JTBOEp7vlZyMofC4+/o9Kwr7Z6Lw7977NWla24Ybm0soaj5TibyAz7Gby7Nfaz8FLoAMr64zDKsqDdlJ9myG60d9fvvpvwFYug8W84SVt8LZ7WKI6b2A5qmWaMjvmeATfMbfYxi9Q==
sidebar_class_name: "get 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={"Read deployment group"}
>
</Heading>

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



Retrieves information about a specific deployment group.


<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 read.","required":true,"schema":{"type":"string"},"example":"1"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</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>