Domain Patterns

Retrieves a domain pattern by codebase ID and pattern ID.

get/codebases/{codebaseId}/domain-patterns/{patternId}

Request

Path parameters

codebaseIdstring required

Unique identifier for the codebase.

patternIdstring required

Unique identifier for the domain pattern.

Response

OK

idstring required

Unique identifier for the domain pattern.

patternstring required

The domain pattern string, optionally followed by a single path segment (e.g. [site-name].[environment-name].acme.com/app). Both [site-name] and [environment-name] tokens are mandatory at codebase level. Domain rules (enforced in service layer): ≤ 200 chars excluding token placeholders, at least 2 components (must contain .), no IP addresses, no forbidden suffixes (acquia-sites.com, hosting.acquia.com), no wildcards, no leading/trailing dot or hyphen, no consecutive dots, no query string or fragment. Path rules: optional, max 255 chars, must match ^/[A-Za-z0-9._-]+$, max 1 segment. DNS label limit: 63 chars after token substitution ([site-name] ≤ 14 chars, [environment-name] ≤ 10 chars). One pattern per codebase.

_embeddedobject

Embedded resources (optional)

Example response

{
  "pattern": "[site-name].[environment-name].acme.com",
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

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