ACacquia
Launch Groups

Retrieves a launch group by ID.

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.

get/launch-groups/{launchGroupId}

Request

Path parameters

launchGroupIdstring required

Unique identifier for the launch group.

Response

Launch group details

idstring required

Unique identifier for the launch group.

namestring 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.

descriptionstring 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_idstring required

Identifier of the codebase this launch group belongs to.

fqdnstring 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).

_embeddedobject

Embedded resources (optional)

Example response

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "MyLaunchGroup",
  "description": "Marketing campaign for Q3 launch",
  "codebase_id": "d3f7270e-c45f-4801-9308-5e8afe84a323",
  "fqdn": "mylaunchgroup-a1b2c3d-lg.prod.acquia-sites.com",
  "status": "idle",
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    },
    "member-site-instances": {
      "href": "https://api.acquia.com/v3/resources/1"
    },
    "domains": {
      "href": "https://api.acquia.com/v3/resources/1"
    },
    "dns-recheck": {
      "href": "https://api.acquia.com/v3/resources/1"
    },
    "publish": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.