--- title: "Retrieves a launch group by ID." method: GET path: "/launch-groups/{launchGroupId}" tags: ["Launch Groups"] --- # Retrieves a launch group by ID. `GET /launch-groups/{launchGroupId}` ## Request - Base URL: `https://api.acquia.com/v3` - URL: `https://api.acquia.com/v3/launch-groups/{launchGroupId}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the launch group read model. Does not embed member site instances or domains; retrieve them from `GET /launch-groups/{launchGroupId}/member-site-instances` and `GET /launch-groups/{launchGroupId}/domains`. Requires the `view launch group` permission. ## Path parameters - `launchGroupId` string, required ## Response `200` Launch group details - object - `id` string, required: Unique identifier for the launch group. - `name` string, required: The name of the launch group. Alphanumeric only; maximum 52 characters. Can be changed via `PUT /launch-groups/{launchGroupId}`; renaming does not regenerate `fqdn`, so the two may permanently disagree after a rename. - `description` string, nullable, required: An optional, free-text description of the launch group. Always present in the response; null if none is currently set -- either because none was ever supplied or because a later update via `PUT /launch-groups/{launchGroupId}` cleared it. - `codebase_id` string, required: Identifier of the codebase this launch group belongs to. - `fqdn` string, required: The Acquia-generated fully-qualified domain name customers CNAME their custom domains to. Generated once from the lowercased name the group had at creation and never regenerated afterward, including when `name` is later changed via `PUT /launch-groups/{launchGroupId}`, so `name` and `fqdn` may permanently disagree. - `status` 'idle' | 'switch-in-progress' | 'failed' | 'degraded', required: The current state of the launch group. `switch-in-progress` while a publish switch is running; `failed` if the last publish switch did not complete (safe to retry); `degraded` if the group has no Published member (for example, its Published site instance was deleted at the platform level). - `_links` object, required: HAL links for the resource - `self` LaunchGroupAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `member-site-instances` LaunchGroupAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `domains` LaunchGroupAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `dns-recheck` LaunchGroupAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `publish` LaunchGroupAPIHalLink: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `_embedded` object: Embedded resources (optional) ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)