ACacquia
Domains

Retrieves details for the specified domain on a site instance.

get/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).

Response

Domain details

namestring required

The domain name.

is_managedboolean required

Whether the domain is managed by Acquia. false for custom and true for every other type. When type is absent, is_managed is still present and carries the platform's own value for the domain, which is false when the platform holds no recorded type. Read-only; there is no is_managed write parameter.

type'custom' | 'environment-pattern' | 'codebase-pattern' | 'acquia' | 'launch-group'

The type of the domain. custom is a customer's own domain. acquia is the generated default domain for the site instance. environment-pattern and codebase-pattern are platform-generated pattern domains. launch-group marks the domain as belonging to a launch group rather than to the site instance directly; it is requested on write via the type request property and is restricted to Acquia staff. Absent when the platform holds no recorded type for the domain, or reports one this API does not recognise.

_embeddedobject

Embedded resources (optional)

Example response

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

Changes

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