---
title: "Retrieves a Source site's configuration as YAML"
method: GET
path: "/source-sites/{sourceSiteId}/config"
tags: ["Source Sites"]
---

# Retrieves a Source site's configuration as YAML

`GET /source-sites/{sourceSiteId}/config`

## Request

- Base URL: `https://api.acquia.com/v3`
- URL: `https://api.acquia.com/v3/source-sites/{sourceSiteId}/config`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/source-sites/:sourceSiteId/config/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `sourceSiteId` string, required

## Response `200`

The active configuration of the site

- object
  - `configuration` string, 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`.
  - `_links` object, required: HAL links for the resource
    - `self` SourcePlatformAPIHalLink, required: HAL link object
      - `href` union, required: The target URI of the link (can be a URI or URI template)
        - string, uri
        - string, uri-template
      - `templated` boolean: Whether the link is a URI template
      - `type` string: Hint about the media type expected when dereferencing the target resource
      - `deprecation` string: A URL to a resource that provides deprecation information
      - `name` string: A secondary key for selecting links
      - `profile` string: A URI that hints about the profile of the target resource
      - `title` string: A human-readable identifier for the link
      - `hreflang` string: The language of the target resource
  - `_embedded` object: Embedded resources (optional)

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)