Domains

Retrieves the DNS status for the specified domain on a site instance.

get/site-instances/{siteId}.{environmentId}/domains/{domainName}/status

Request

Base URL
https://api.acquia.com/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/site-instances/:siteId.:environmentId/domains/:domainName/status/get.ts
A function with typed inputs. Its response is checked against the schema.

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

Domain DNS status details

hostnamestring required

The domain name.

site_idstring required

Identifier of the site this domain belongs to.

environment_idstring required

Identifier of the environment this domain belongs to.

ip_addressesstring[] required

List of IP addresses resolving for this domain.

cnamesstring[] required

List of CNAME records resolving for this domain.

_embeddedobject

Embedded resources (optional)

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

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