ACacquia
Launch Groups

Partially updates a launch group's name and/or description.

Updates a launch group's name and/or description. This is a partial update, not a full replace — name and description are each independently optional, and omitting either leaves it unchanged. There is no way to clear name; submitting it as null is rejected. An explicit null, an empty string, or a whitespace-only description all clear it. At least one of name/description must be present. The launch group's fqdn is generated once, from the name the group had at creation, and is never regenerated when name changes, so name and fqdn may permanently disagree after a rename. Requires the manage launch group permission.

put/launch-groups/{launchGroupId}

Request

Path parameters

launchGroupIdstring required

Unique identifier for the launch group.

Request body

namestring

The name of the launch group. Alphanumeric only; maximum 52 characters. Optional: omitting this property leaves the current name unchanged. There is no way to clear the name -- submitting it as null is rejected. Renaming a launch group deliberately does not change its fqdn -- the FQDN is generated once, from the name the group had at creation, and is never regenerated, so name and fqdn may permanently disagree after a rename.

descriptionstring nullable

An optional, free-text description of the launch group. Omitting this property leaves the current description unchanged. An explicit null value, an empty string (""), or a string that normalizes to one, all clear it to no description. 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.

Response

Launch group update started

_embeddedobject

Embedded resources (optional)

message'Launch group update started.' required

Confirmation message that launch group update 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.