Sorry, no results found for "".

Show examples in:

Javascript HTTP

Endpoint info

Body parameters

Returns

Available examples

Basic example

Content Management API > Site

Update the site's settings

Body parameters

no_index boolean Optional

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

favicon string, null Optional

The upload id for the favicon

Example:

"123"

global_seo object, null Optional

Specifies default global settings

site_name string Optional

Site name, used in social sharing

Example:

"My Awesome Website"

fallback_seo object Optional

title string Required

Example:

"Default meta title"

description string Required

Example:

"Default meta description"

image null, string Required

The id of the image

Example:

"123"

twitter_card null, enum Optional

Determines how a Twitter link preview is shown

Example:

"summary_large_image"

summary Optional

Twitter summary card

summary_large_image Optional

Twitter summary card with large image

title_suffix null, string Optional

Title meta tag suffix

Example:

" - My Awesome Website"

facebook_page_url null, string Optional

URL of facebook page

Example:

"http://facebook.com/awesomewebsite"

twitter_account null, string Optional

Twitter account associated to website

Example:

"@awesomewebsite"

name string Optional

Site name

Example:

"My Awesome Website"

theme undefined Optional

locales Optional

Available locales

Type: Array<string>

Example:

["en"]

timezone string Optional

Site default timezone

Example:

"Europe/London"

require_2fa boolean Optional

Specifies whether all users of this site need to authenticate using two-factor authentication

ip_tracking_enabled boolean Optional

Specifies whether you want IPs to be tracked in the Project usages section

force_use_of_sandbox_environments boolean Optional

If enabled, blocks schema changes of primary environment

meta.improved_timezone_management boolean Optional

Whether the Improved API Timezone Management option is active or not

meta.improved_hex_management boolean Optional

Whether the Improved API Hex Management option is active or not

meta.improved_gql_multilocale_fields boolean Optional

Whether the Improved GraphQL multi-locale fields option is active or not

meta.improved_gql_visibility_control boolean Optional

Whether the Improved GraphQL visibility control option is active or not

meta.improved_boolean_fields boolean Optional

Whether the Improved boolean fields option is active or not

meta.custom_upload_storage_settings boolean Optional

Whether the site has custom upload storage settings

sso_default_role Optional

Type: ResourceLinkage<"role">

Returns

Returns a resource object of type site

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const site = await client.site.update({});
7

8
  // Check the 'Returned output' tab for the result ☝️
9
  console.log(site);
10
}
11

12
run();

1
{
2
  id: "155",
3
  domain: "admin.my-awesome-website.com",
4
  favicon: "123",
5
  global_seo: {},
6
  google_maps_api_token: "xxxxxxxxxxxxx",
7
  imgix_host: "www.datocms-assets.com",
8
  internal_domain: "my-website.admin.datocms.com",
9
  last_data_change_at: "2017-03-30T09:29:14.872Z",
10
  locales: ["en"],
11
  name: "My Awesome Website",
12
  no_index: true,
13
  require_2fa: false,
14
  theme: {
15
    type: "monochromatic",
16
    hue: 16,
17
    primary_color: { red: 128, green: 128, blue: 128, alpha: 128 },
18
    light_color: { red: 128, green: 128, blue: 128, alpha: 128 },
19
    accent_color: { red: 128, green: 128, blue: 128, alpha: 128 },
20
    dark_color: { red: 128, green: 128, blue: 128, alpha: 128 },
21
    logo: "123",
22
  },
23
  timezone: "Europe/London",
24
  ip_tracking_enabled: true,
25
  force_use_of_sandbox_environments: true,
26
  assets_cdn_default_settings: { image: {}, video: {} },
27
  meta: {
28
    created_at: "2020-04-21T07:57:11.124Z",
29
    improved_timezone_management: true,
30
    improved_hex_management: true,
31
    improved_gql_multilocale_fields: true,
32
    improved_gql_visibility_control: true,
33
    improved_boolean_fields: true,
34
  },
35
  item_types: [{ type: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" }],
36
  owner: { type: "account", id: "312" },
37
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.