ACacquia
Launch Groups

Creates a new launch group for a codebase.

Creates a new launch group belonging to the specified codebase, designates the initial Published site instance, generates the group's shared FQDN, and registers it on the platform. Requires the create launch group permission.

post/codebases/{codebaseId}/launch-groups

Request

Path parameters

codebaseIdstring required

Unique identifier for the codebase.

Request body

namestring required

The name of the launch group. Alphanumeric only; maximum 52 characters.

site_idstring required

Identifier of the site to designate as the initial Published site instance.

environment_idstring required

Identifier of the environment the initial Published site instance runs in.

descriptionstring nullable

An optional, free-text description of the launch group. Can be changed later via PUT /launch-groups/{launchGroupId}. Leading and trailing whitespace (including common non-ASCII whitespace such as non-breaking or ideographic spaces, but not invisible zero-width characters or exotic control characters, which count as real content) is stripped before persisting, and the 512-character maxLength above is measured on the string after that stripping, not on the raw submitted value. A null value, an empty string (""), or a string that normalizes to one, all mean no description.

Response

Launch group creation started

_embeddedobject

Embedded resources (optional)

message'Launch group creation started.' required

Confirmation message that launch group creation has been started.

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

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