Enterprise Project Exports

The Project Export feature allows Enterprise customers to export all content and assets from their DatoCMS project to their own AWS S3 bucket. This export provides a structured snapshot of your data in JSON format, along with all uploaded assets.

Key Points to Consider

• Enterprise Only: This feature is available exclusively to Enterprise customers.

• Not a Backup Solution: The export does not offer a one-click restoration process.

• Primary Environment Only: Only the primary project environment is included in the export.

• Automated and Scheduled: Exports occur on a predefined schedule, with a minimum frequency of once per month and a maximum of once per day.

• AWS S3 Storage Required: Customers must configure their own S3 bucket to receive the exported data.

What is Included in the Export?

The exported data includes:

• Schema Models: Fields and fieldsets.

• Schema Blocks: Block definitions and fields.

• Records: Current and published versions, including block records.

• Uploads: Metadata and references for uploaded assets.

• Project Settings: Locales, SEO settings, workflows, and installed plugins.

• Asset Files: All uploaded files from the media area.

JSON Snapshots vs. Asset Syncing

While JSON snapshots are periodic and remain unchanged once created, assets are simply synced to their latest versions in the same directory every time. This is why bucket versioning is recommended—if an asset is removed from the project, it will also be deleted from the bucket. However, with versioning enabled, you can still retrieve previous versions of deleted assets.

What is NOT Included?

The export does not include:

• Record revision history

• API tokens, webhooks, and build triggers

• Collaborators, roles, and permissions

• Audit logs and usage statistics

• SSO settings and user accounts

• Any additional metadata not explicitly listed

How to enable Project Export

This feature cannot be enabled by customers directly. To set up an export, you must contact DatoCMS support and provide the following AWS S3 details:

• S3 Bucket Name

• AWS Region

• S3 Access Key ID

• S3 Secret Access Key

Additionally, you must configure your AWS S3 bucket with:

• Public access blocked (mandatory for security)

• Bucket versioning enabled (recommended for data recovery)

• Lifecycle rules (optional, for automatic cleanup of old snapshots)

Our support team will give you detailed instructions on how to setup everything correctly.

Export structure

Once configured, each export generates a timestamped snapshot in your S3 bucket. The structure is as follows:

1
assets/
2
  project_<ID>/
3
    file1.png
4
    file2.mp4
5

6
content/
7
  project_<ID>/
8
    snapshot_<TIMESTAMP>/
9
      models/
10
      records/
11
      uploads/
12
      workflows/
13
      site.json

The presence of a canary.txt file in a snapshot directory confirms that the export was completed successfully.

JSON files format

JSON files in the snapshots are similar to the JSON content you can fetch from our Content Management API, with some changes to reduce scattering across multiple files.

Schema

For each schema model/block model, a file following this path is present in the bucket:

content/project_<ID>/snapshot_<TIMESTAMP>/models/<api_key>.json

For instance:

content/project_999/snapshot_1721033044/models/article.json

The data key contains the item_type resource. Fields and fieldsets are referenced by their IDs, and their full payload is present in the included key.

1
{
2
  "data": {
3
    "id": "UVP2y5QPToWPXqJbMszyFg",
4
    "type": "item_type",
5
    "attributes": {
6
      "api_key": "article",
7
      "name": "Article",
8
      // ... the rest of item_type attributes
9
    },
10
    "relationships": {
11
      "fields": {
12
        "data": [
13
          { "id": "InMbgf7BSo2TDG4HYGb2Ug", "type": "field" }
14
        ]
15
      },
16
      "fieldsets": {
17
        "data": [
18
          { "id": "bwk17lanRYCOvXKztPp5PA", "type": "fieldset" }
19
        ]
20
      },
21
      "workflow": {
22
        "data": { "id": "MQLtfJv4Q22nKUoHEQ3b9A", "type": "workflow" }
23
      }
24
    },
25
    "meta": { "has_singleton_item": false }
26
  },
27
  "included": [
28
    {
29
      "id": "InMbgf7BSo2TDG4HYGb2Ug",
30
      "type": "field",
31
      "attributes": {
32
        "label": "Content",
33
        // ... the rest of field attributes
34
      },
35
      "relationships": {
36
        "item_type": {
37
          "data": { "id": "UVP2y5QPToWPXqJbMszyFg", "type": "item_type" }
38
        },
39
        "fieldset": {
40
          "data": { "id": "bwk17lanRYCOvXKztPp5PA", "type": "fieldset" }
41
        }
42
      }
43
    },
44
    {
45
      "id": "bwk17lanRYCOvXKztPp5PA",
46
      "type": "fieldset",
47
      "attributes": {
48
        "title": "Group 1",
49
        // ... the rest of fieldset attributes
50
      },
51
      "relationships": {
52
        "item_type": {
53
          "data": { "id": "UVP2y5QPToWPXqJbMszyFg", "type": "item_type" }
54
        }
55
      }
56
    }
57
  ]
58
}

Records

For each schema model, multiple files following this template are present in the bucket:

content/project_<ID>/snapshot_<TIMESTAMP>/records/<schema_model_api_key>/current/batch_<batch_increment_number>.json
content/project_<ID>/snapshot_<TIMESTAMP>/records/<schema_model_api_key>/published/batch_<batch_increment_number>.json

For instance:

content/project_999/snapshot_1721033044/records/article/current/batch_000.json
content/project_999/snapshot_1721033044/records/article/current/batch_001.json
content/project_999/snapshot_1721033044/records/article/published/batch_000.json
content/project_999/snapshot_1721033044/records/article/published/batch_001.json

The current prefix contains the records' current versions (the latest version available, as seen in the admin interface). The published prefix contains records' published versions.

The same record ID can be present in both trees (current and published) if it has both a current and a published version. The same version can be present in both trees if it's at the same time the current and published version of the record.

Versions include their block records, similar to using the nested=true query parameter in our Content Management API.

Each batch_XXX.json contains several versions under the data key and their order is not predictable.

1
{
2
  "data": [
3
    {
4
      "id": "ZrKQnn5AQBiZ4CTX8eyu8Q",
5
      "type": "item",
6
      "attributes": {
7
        "title": "A trip to Florence!",
8
        "content": {
9
          "en": [
10
            {
11
              "type": "item",
12
              "attributes": {
13
                "text": "Beautiful!"
14
                // ... the rest of block record attributes
15
              },
16
              "relationships": {
17
                "item_type": {
18
                  "data": {
19
                    "id": "JfkKRx-FRJONbco_hHOS5Q",
20
                    "type": "item_type"
21
                  }
22
                }
23
              },
24
              "id": "afzDcUT0RHOduJbr8L_ZmA"
25
            }
26
          ]
27
        }
28
        // ... the rest of record attributes
29
      },
30
      "relationships": {
31
        "item_type": {
32
          "data": { "id": "UVP2y5QPToWPXqJbMszyFg", "type": "item_type" }
33
        },
34
        "creator": { "data": { "id": "24527", "type": "account" } }
35
      },
36
      "meta": {
37
        // ...
38
      }
39
    },
40
    {
41
      // .. other current versions
42
    }
43
  ]
44
}