ACacquia
Domains

Adds a domain to the specified site instance.

Adds a domain to the specified site instance. Accepts a JSON body whose type property is optional, defaulting to custom when omitted or when the body is {}; a request with no body at all is treated as {}. type: launch-group marks the domain as belonging to a launch group rather than to the site instance directly, and is restricted to Acquia staff — a non-elevated caller's request is rejected with 403. Domains of this type are still returned in standard domain listings, and traffic continues to route to them. Adding a domain under an Acquia-reserved domain suffix (e.g. acquia-sites.com) is restricted to Acquia staff, as is adding a path-based domain; either is rejected with 403 for a non-elevated caller.

put/site-instances/{siteId}.{environmentId}/domains/{domainName}

Request

Path parameters

siteIdstring required

Unique identifier for the site.

environmentIdstring required

Unique identifier for the environment.

domainNamestring required

The fully-qualified domain name (e.g., www.example.com).

Request body

type'custom' | 'launch-group'

Optional. The type to register the domain under, defaulting to custom when omitted. launch-group marks the domain as belonging to a launch group rather than to the site instance directly; it is restricted to Acquia staff, and is rejected with 403 for any other caller. The three platform-owned types — acquia, environment-pattern, codebase-pattern — are read-only and rejected with 400 if requested here.

Response

Domain addition started

_embeddedobject

Embedded resources (optional)

message'Domain addition started.' required

Confirmation message that the domain addition 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.