> ## Documentation Index
> Fetch the complete documentation index at: https://snowseo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# SnowCMS Settings

> Read a brand's SnowCMS blog setup: domains, blog path and feed switches.

Get the brand's SnowCMS blog setup:

| Field | Description |
| - | - |
| `baseUrl` | The brand's free SnowCMS address. It is also the CNAME target for a custom domain. |
| `domain`, `status` | The connected custom domain and its verification status, or `null`. |
| `verifyHost`, `verifyToken` | The TXT record that proves you own the custom domain. |
| `pathPrefix`, `publicUrl` | Where the custom domain serves the blog, and the URL search engines index. |
| `feedEnabled` | Whether the blog is on. |
| `feedAutoPublish` | Whether published articles go public automatically. |

To change these, see [Update SnowCMS Settings](https://snowseo.com/docs/api-reference/endpoints/snowcms-settings-update.md) and [Set the Blog Path](https://snowseo.com/docs/api-reference/endpoints/snowcms-blog-path.md).


## OpenAPI

````yaml GET /v3/custom-domains
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security:
  - bearerAuth: []
  - apiKey: []
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/custom-domains:
    get:
      tags:
        - Custom Domains
      summary: Get the SnowCMS domain state
      description: >-
        The brand's SnowCMS blog: its free base URL, any connected custom domain
        with its status and DNS records, the blog path and public URL, whether
        the blog is on (`feedEnabled`), and whether published articles go public
        automatically (`feedAutoPublish`).
      parameters:
        - schema:
            type: string
          in: query
          name: teamId
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      baseUrl:
                        type: string
                      domain:
                        type: string
                        nullable: true
                      status:
                        type: string
                        nullable: true
                      cnameTarget:
                        type: string
                      verifyHost:
                        type: string
                        nullable: true
                      verifyToken:
                        type: string
                        nullable: true
                      pathPrefix:
                        type: string
                        nullable: true
                      publicUrl:
                        type: string
                        nullable: true
                      feedEnabled:
                        type: boolean
                      feedAutoPublish:
                        type: boolean
                      brandSlug:
                        type: string
                        nullable: true
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your SnowSEO API key (sk_...).
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.