# Site

A site represents a specific DatoCMS administrative area

## Object payload

**`id`**

- Type: string
- Example: `"155"`

ID of site

**`type`**

- Type: string

Must be exactly `"site"`.

**`domain`**

- Type: string, null
- Example: `"admin.my-awesome-website.com"`

Administrative area custom domain

**`favicon`**

- Type: string, null
- Example: `"123"`

The upload id for the favicon

**`global_seo`**

- Type: object, null

Specifies default global settings

<details>
<summary>Show object format</summary>

**`site_name`**

- Type: string
- Example: `"My Awesome Website"`

Site name, used in social sharing

**`fallback_seo`**

- Type: object

<details>
<summary>Show object format</summary>

**`title`**

- Type: string
- Example: `"Default meta title"`

**`description`**

- Type: string
- Example: `"Default meta description"`

**`image`**

- Type: null, string
- Example: `"123"`

The id of the image

**`twitter_card`**

- Type: null, enum
- Example: `"summary_large_image"`

Determines how a Twitter link preview is shown

<details>
<summary>Show enum values</summary>

**`summary`**

Twitter summary card

**`summary_large_image`**

Twitter summary card with large image

</details>

</details>

**`title_suffix`**

- Type: null, string
- Example: `" - My Awesome Website"`

Title meta tag suffix

**`facebook_page_url`**

- Type: null, string
- Example: `"http://facebook.com/awesomewebsite"`

URL of facebook page

**`twitter_account`**

- Type: null, string
- Example: `"@awesomewebsite"`

Twitter account associated to website

</details>

**`google_maps_api_token`**

- Type: string, null
- Example: `"xxxxxxxxxxxxx"`

Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.

**`imgix_host`**

- Type: string, null
- Example: `"www.datocms-assets.com"`

Imgix host

**`internal_domain`**

- Type: string, null
- Example: `"my-website.admin.datocms.com"`

DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot read the configuration of the project.

**`last_data_change_at`**

- Type: null, date-time
- Example: `"2017-03-30T09:29:14.872Z"`

Specifies the last time when a change of data occurred

**`locales`**

- Type: Array\<string\>
- Example: `["en"]`

Available locales

**`name`**

- Type: string
- Example: `"My Awesome Website"`

Site name

**`no_index`**

- Type: boolean

Whether the website needs to be indexed by search engines or not

**`require_2fa`**

- Type: boolean, null

Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot read the configuration of the project.

**`theme`**

- Type: object

Specifies the theme to use in administrative area. For monochromatic themes the response only includes type, hue, and logo — frontends must derive the palette from the hue. For custom themes the primary_color, light_color, accent_color, and dark_color fields are returned.

<details>
<summary>Show object format</summary>

**`type`**

- Type: enum
- Example: `"monochromatic"`

If type is monochromatic, the hue will determine the color palette. Dark color is a legacy property, and it won't be used on the interface

<details>
<summary>Show enum values</summary>

**`custom`**

Use custom color palette (deprecated)

**`monochromatic`**

Use monochromatic, accessible color palette

</details>

**`hue`**

- Type: integer, null
- Example: `16`

If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.

**`logo`**

- Type: string, null
- Example: `"123"`

The upload ID that is used as the logo for the project

**`color_channel`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

<details>
<summary>Show deprecated</summary>

**`color`**

- Deprecated
- Type: object

An RGBA color value

Custom color palettes are deprecated.

<details>
<summary>Show object format</summary>

**`red`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`green`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`blue`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`alpha`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

</details>

**`primary_color`**

- Deprecated
- Type: object

An RGBA color value

Custom color palettes are deprecated.

<details>
<summary>Show object format</summary>

**`red`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`green`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`blue`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`alpha`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

</details>

**`light_color`**

- Deprecated
- Type: object

An RGBA color value

Custom color palettes are deprecated.

<details>
<summary>Show object format</summary>

**`red`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`green`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`blue`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`alpha`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

</details>

**`accent_color`**

- Deprecated
- Type: object

An RGBA color value

Custom color palettes are deprecated.

<details>
<summary>Show object format</summary>

**`red`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`green`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`blue`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`alpha`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

</details>

**`dark_color`**

- Deprecated
- Type: object

An RGBA color value

Custom color palettes are deprecated.

<details>
<summary>Show object format</summary>

**`red`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`green`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`blue`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

**`alpha`**

- Type: integer
- Example: `128`

An integer color channel value (0-255)

</details>

</details>

</details>

**`timezone`**

- Type: string
- Example: `"Europe/London"`

Site default timezone

**`ip_tracking_enabled`**

- Type: boolean, null

Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot read the configuration of the project.

**`force_use_of_sandbox_environments`**

- Type: boolean

If enabled, blocks schema changes of primary environment

**`assets_cdn_default_settings`**

- Type: object

Allows setting default parameters for assets served through the CDN

<details>
<summary>Show object format</summary>

**`image`**

- Type: object

Allows setting default parameters for optimizing images served by the CDN

<details>
<summary>Show object format</summary>

**`q`**

- Type: integer
- Example: `50`

Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.

**`auto`**

- Type: Array\<string\>
- Example: `["compress", "format"]`

The auto parameter helps automating a baseline level of optimization. Specify one or more settings

**`cs`**

- Type: enum
- Example: `"srgb"`

Specifies the color space of the output image

<details>
<summary>Show enum values</summary>

**`srgb`**

Uses the sRGB colorspace which is an internet standard. This is the default

**`adobergb1998`**

Refers to the Adobe RGB (1998) color space, which provides accurate color reproduction from screen to print

**`tinysrgb`**

Reduces the color space metadata but may cause a slight shift in color values

**`strip`**

Removes the colorspace for maximum size reduction. Note that colors will still be rendered, but a colorspace will not be specified

**`origin`**

Keeps the color space of the origin image. This is the default value unless auto=compress

</details>

</details>

**`video`**

- Type: object

Allows setting default parameters for optimizing videos served by the CDN

<details>
<summary>Show object format</summary>

**`disable_serving_raw_videos`**

- Type: boolean

When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code

</details>

</details>

**`meta.created_at`**

- Type: date-time

Date of project creation

**`meta.improved_timezone_management`**

- Type: boolean

Whether the [Improved API Timezone Management](https://www.datocms.com/product-updates/improved-timezone-management) opt-in product update is active or not

**`meta.improved_hex_management`**

- Type: boolean

Whether the [Improved API Hex Management](https://www.datocms.com/product-updates/improved-hex-management) opt-in product update is active or not

**`meta.improved_gql_multilocale_fields`**

- Type: boolean

Whether the [Improved GraphQL multi-locale fields](https://www.datocms.com/product-updates/improved-gql-multilocale-fields) opt-in product update is active or not

**`meta.improved_gql_visibility_control`**

- Type: boolean

Whether the [Improved GraphQL visibility control](https://www.datocms.com/product-updates/improved-gql-visibility-control) opt-in product update is active or not

**`meta.improved_boolean_fields`**

- Type: boolean

Whether the [Improved boolean fields](https://www.datocms.com/product-updates/improved-boolean-fields) opt-in product update is active or not

**`meta.draft_mode_default`**

- Type: boolean

The default value for the draft mode option in all the environment's models

**`meta.improved_validation_at_publishing`**

- Type: boolean

Whether the [Improved validation at publishing](https://www.datocms.com/product-updates/force-validations-on-records-when-publishing) opt-in product update is active or not

**`meta.improved_exposure_of_inline_blocks_in_cda`**

- Type: boolean

Whether the [Improved exposure of inline blocks in the Content Delivery API](https://www.datocms.com/product-updates/improved-exposure-of-inline-blocks-in-cda) opt-in product update is active or not

**`meta.improved_items_listing`**

- Type: boolean

Whether the [Improved items listing](https://www.datocms.com/product-updates/improved-items-listing) opt-in product update is active or not

**`meta.milliseconds_in_datetime`**

- Type: boolean

Whether the [Milliseconds in datetime](https://www.datocms.com/product-updates/milliseconds-in-datetime) opt-in product update is active or not

**`meta.non_localized_focal_points`**

- Type: boolean

Whether the [Non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) opt-in product update is active or not

**`meta.allow_custom_theme`**

- Type: boolean

Whether the project can still use a custom color palette for the theme. Custom palettes are deprecated.

**`meta.custom_upload_storage_settings`**

- Type: boolean

Whether the site has custom upload storage settings

**`item_types`**

- Type: Array<[ResourceLinkage\<"item_type"\>](https://www-draft.datocms.com/docs/content-management-api/resources/item_type.md)>

**`owner`**

- Type: [ResourceLinkage\<"account"\>](https://www-draft.datocms.com/docs/content-management-api/resources/account.md), [ResourceLinkage\<"organization"\>](https://www-draft.datocms.com/docs/content-management-api/resources/organization.md)

<details>
<summary>Show deprecated</summary>

**`account`**

- Deprecated
- Type: null, [ResourceLinkage\<"account"\>](https://www-draft.datocms.com/docs/content-management-api/resources/account.md)

Please user the owner relationship instead

</details>

## Available endpoints

-   [Retrieve the site](https://www.datocms.com/docs/content-management-api/resources/site/self.md)
-   [Update the site's settings](https://www.datocms.com/docs/content-management-api/resources/site/update.md)

## Related content in "Content Management API"

- [Content Management API Overview](https://www.datocms.com/docs/content-management-api.md)
- [Using the JavaScript CMA client](https://www.datocms.com/docs/content-management-api/using-the-nodejs-clients.md)
- [API versioning](https://www.datocms.com/docs/content-management-api/api-versioning.md)
- [Authentication](https://www.datocms.com/docs/content-management-api/authentication.md)
- [Environments](https://www.datocms.com/docs/content-management-api/setting-the-environment.md)
- [Error codes & handling failures (CMA)](https://www.datocms.com/docs/content-management-api/errors.md)
- [Pagination](https://www.datocms.com/docs/content-management-api/pagination.md)
- [Asynchronous jobs](https://www.datocms.com/docs/content-management-api/async-jobs.md)
- [CMA Technical Limits & Rate Limits](https://www.datocms.com/docs/content-management-api/technical-limits.md)
- [Record](https://www.datocms.com/docs/content-management-api/resources/item.md)
- [Scheduled publication](https://www.datocms.com/docs/content-management-api/resources/scheduled-publication.md)
- [Scheduled unpublishing](https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing.md)
- [Upload](https://www.datocms.com/docs/content-management-api/resources/upload.md)
- [Site](https://www.datocms.com/docs/content-management-api/resources/site.md)
- [Retrieve the site](https://www.datocms.com/docs/content-management-api/resources/site/self.md)
- [Update the site's settings](https://www.datocms.com/docs/content-management-api/resources/site/update.md)
- [Model/Block model](https://www.datocms.com/docs/content-management-api/resources/item-type.md)
- [Field](https://www.datocms.com/docs/content-management-api/resources/field.md)
- [Fieldset](https://www.datocms.com/docs/content-management-api/resources/fieldset.md)
- [Record version](https://www.datocms.com/docs/content-management-api/resources/item-version.md)
- [Upload permission](https://www.datocms.com/docs/content-management-api/resources/upload-request.md)
- [Upload track](https://www.datocms.com/docs/content-management-api/resources/upload-track.md)
- [Manual tags](https://www.datocms.com/docs/content-management-api/resources/upload-tag.md)
- [Smart tags](https://www.datocms.com/docs/content-management-api/resources/upload-smart-tag.md)
- [Upload Collection](https://www.datocms.com/docs/content-management-api/resources/upload-collection.md)
- [Search Index](https://www.datocms.com/docs/content-management-api/resources/search-index.md)
- [Search result](https://www.datocms.com/docs/content-management-api/resources/search-result.md)
- [Search indexing activity](https://www.datocms.com/docs/content-management-api/resources/search-index-event.md)
- [Environment](https://www.datocms.com/docs/content-management-api/resources/environment.md)
- [Maintenance mode](https://www.datocms.com/docs/content-management-api/resources/maintenance-mode.md)
- [Menu Item](https://www.datocms.com/docs/content-management-api/resources/menu-item.md)
- [Schema Menu Item](https://www.datocms.com/docs/content-management-api/resources/schema-menu-item.md)
- [Uploads filter](https://www.datocms.com/docs/content-management-api/resources/upload-filter.md)
- [Model filter](https://www.datocms.com/docs/content-management-api/resources/item-type-filter.md)
- [Plugin](https://www.datocms.com/docs/content-management-api/resources/plugin.md)
- [Workflow](https://www.datocms.com/docs/content-management-api/resources/workflow.md)
- [Asynchronous job](https://www.datocms.com/docs/content-management-api/resources/job.md)
- [Job result](https://www.datocms.com/docs/content-management-api/resources/job-result.md)
- [Account](https://www.datocms.com/docs/content-management-api/resources/account.md)
- [Organization](https://www.datocms.com/docs/content-management-api/resources/organization.md)
- [Invitation](https://www.datocms.com/docs/content-management-api/resources/site-invitation.md)
- [Collaborator](https://www.datocms.com/docs/content-management-api/resources/user.md)
- [Role](https://www.datocms.com/docs/content-management-api/resources/role.md)
- [API token](https://www.datocms.com/docs/content-management-api/resources/access-token.md)
- [Webhook](https://www.datocms.com/docs/content-management-api/resources/webhook.md)
- [Webhook call](https://www.datocms.com/docs/content-management-api/resources/webhook-call.md)
- [Build trigger](https://www.datocms.com/docs/content-management-api/resources/build-trigger.md)
- [Deploy activity](https://www.datocms.com/docs/content-management-api/resources/build-event.md)
- [Subscription limit](https://www.datocms.com/docs/content-management-api/resources/subscription-limit.md)
- [Subscription feature](https://www.datocms.com/docs/content-management-api/resources/subscription-feature.md)
- [SSO Settings](https://www.datocms.com/docs/content-management-api/resources/sso-settings.md)
- [SSO User](https://www.datocms.com/docs/content-management-api/resources/sso-user.md)
- [SSO Group](https://www.datocms.com/docs/content-management-api/resources/sso-group.md)
- [White-label settings](https://www.datocms.com/docs/content-management-api/resources/white-label-settings.md)
- [Audit log event](https://www.datocms.com/docs/content-management-api/resources/audit-log-event.md)