ACacquia
Source Sites

Retrieves a Source site's configuration as YAML

Returns the active configuration of a Source CMS site in the configuration property, as a single YAML document.

Reading the configuration runs a task against the site, so the request is held open until that task finishes (typical: a few seconds). The request fails (500) rather than returning a partial document or a 504, because it means something is very wrong (a 504 would invite a retry, which likely would fail identically).

Permissions: The authenticated user must have the site admin role on the site.

get/source-sites/{sourceSiteId}/config

Request

Path parameters

sourceSiteIdstring required
Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

Unique identifier for the Source site.

Response

The active configuration of the site

configurationstring required

The site's configuration as a single YAML document, keyed by config collection, then config name. The default collection is the empty string; other collections are named after their language (for example language.nl).

Nothing bounds how large this is: a site's configuration is as big as it is. The write caps what it accepts at 1 MiB, so a site whose configuration exceeds that can be read but not written back — a limit of the service, tracked as DXBE-97.

The document carries the UUID Source CMS holds for the site, in its system.site object. That UUID marks where the configuration came from, and an import refuses a document whose UUID does not match the target site. It is not the same identifier as sourceSiteId.

_embeddedobject

Embedded resources (optional)

Example response

{
  "configuration": "'':\n    system.site:\n        name: 'My site'\n        uuid: 7c1f0a94-5d3b-4e18-9a62-0b8d4c5e6f70\n    node.type.article:\n        name: Article\nlanguage.nl:\n    node.type.article:\n        name: Artikel\n",
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

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