contentful-import

Contentful import tool

Contentful provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.

This library helps you to import files generated by contentful-export to a destination space.

:exclamation: Usage as CLI

We moved the CLI version of this tool into our Contentful CLI. This allows our users to use and install only one single CLI tool to get the full Contentful experience.

Please have a look at the Contentful CLI import command documentation to learn more about how to use this as command line tool.

:cloud: Pre-requisites && Installation

Pre-requisites

• Node >= 22

Installation

npm install contentful-import

:hand: Usage as a module

const contentfulImport = require('contentful-import')

const options = {
  content: {entries:..., contentTypes:..., locales:...},
  spaceId: '<space_id>',
  managementToken: '<content_management_api_key>',
  ...
}

contentfulImport(options)
  .then(() => {
    console.log('Data imported successfully')
  })
  .catch((err) => {
    console.log('Oh no! Some errors occurred!', err)
  })

Using ESM:

import spaceImport from "contentful-import";

or

const contentfulImport = require('contentful-import')

const options = {
  contentFile: '/path/to/result/of/contentful-export.json',
  spaceId: '<space_id>',
  managementToken: '<content_management_api_key>',
  ...
}

contentfulImport(options)
  .then(() => {
    console.log('Data imported successfully')
  })
  .catch((err) => {
    console.log('Oh no! Some errors occurred!', err)
  })

💾 Usage as a CLI executable

• Build the package:

$ npm run build

• Execute the CLI tool by running the binary and passing the required parameters

$ ./bin/contentful-cli \
--space-id <space-id> \
--management-token <management-token> \
--content-file <content-file>

Import an environment

const contentfulImport = require('contentful-import')

const options = {
  contentFile: '/path/to/result/of/contentful-export.json',
  spaceId: '<space_id>',
  managementToken: '<content_management_api_key>',
  environmentId: '<environment_id>',
  ...
}

contentfulImport(options)
...

:gear: Configuration options

Basics

spaceId [string] [required]

ID of the space to import into

environmentId [string] [default: 'master']

ID of the environment in the destination space

managementToken [string] [required]

Contentful management API token for the space to be imported to

contentFile [string]

Path to JSON file that contains data to be import to your space

content [object]

Content to import. Needs to match the expected structure (See below)

Filtering

contentModelOnly [boolean] [default: false]

Import content types only

skipContentModel [boolean] [default: false]

Skip importing of content types and locales

skipLocales [boolean] [default: false]

Skip importing of locales

skipContentUpdates [boolean] [default: false]

Skip updating existing content

skipContentPublishing [boolean] [default: false]

Skips content publishing. Creates content but does not publish it

Assets

uploadAssets [boolean] [default: false]

Upload local asset files downloaded via the downloadAssets option of the export. Requires assetsDirectory

skipAssetUpdates [boolean] [default: false]

Skip updating existing assets

assetsDirectory [string]

Path to a directory with an asset export made using the downloadAssets option of the export. Requires uploadAssets

timeout [number] [default: 3000]

Time between retries on asset processing

retryLimit [number] [default: 10]

Maximum number of retries for asset processing

Connection

host [string] [default: 'api.contentful.com']

The Management API host

proxy [string]

Proxy configuration in HTTP auth format: host:port or user:password@host:port

rawProxy [boolean]

Pass proxy config to Axios instead of creating a custom httpsAgent

rateLimit [number] [default: 7]

Maximum requests per second used for API requests

headers [object]

Additional headers to attach to the requests.

Other

errorLogFile [string]

Full path to the error log file

useVerboseRenderer [boolean] [default: false]

Display progress in new lines instead of displaying a busy spinner and the status in the same line. Useful for CI.

config [string]

Path to a JSON file with the configuration options. This file will be merged with the options passed to the function. The options passed to the function will take precedence over the ones in the config file.

:rescue_worker_helmet: Troubleshooting

Proxy

Unable to connect to Contentful through your Proxy? Try to set the rawProxy option to true.

contentfulImport({
  proxy: 'https://cat:[e-mail]:1234',
  rawProxy: true,
  ...
})

Embargoed Assets

If a space is configured to use the embargoed assets feature, certain options will need to be set to use the export/import tooling. When exporting content (using contentful-export), the downloadAssets option must be set to true. This will download the asset files to your local machine. Then, when importing content, the uploadAssets option must be set to true and the assetsDirectory must be set to the directory that contains all of the exported asset folders.

const contentfulImport = require('contentful-import')

const options = {
  contentFile: '/path/to/result/of/contentful-export.json',
  spaceId: '<space_id>',
  managementToken: '<content_management_api_key>',
  uploadAssets: true,
  assetsDirectory: '/path/to/exported/assets.json'
}

contentfulImport(options)

:card_file_box: Expected input data structure

The data to import should be structured like this:

{
  "contentTypes": [],
  "entries": [],
  "assets": [],
  "locales": [],
  "webhooks": [],
  "roles": [],
  "tags": [],
  "editorInterfaces": []
}

Note: tags are not available for all users. If you do not have access to this feature, any tags included in your import data will be skipped.

:bulb: Importing to a space with existing content

• Both source space and destination space must share the same content model structure. In order to achieve that, please use contentful-migration.
• Content transformations are also not supported, please use contentful-migration.
• Entities existence are determined based on their ID:
  • If an entity does not exist in the destination space, it will be created.
  • If an entity already exists in the destination space, it will be updated.
• Publishing strategy:
  • If an entity is in draft, it will be created as draft in the destination space.
  • If an entity is published and has pending changes (updated) in the source space, it will be published with the latest changes in the destination space.

:warning: Limitations

• This tool currently does not support the import of space memberships.
• This tool currently does not support the import of roles.
• This tool is expecting the target space to have the same default locale as your previously exported space.
• Imported webhooks with credentials will be imported as normal webhooks. Credentials should be added manually afterwards.
• Imported webhooks with secret headers will be imported without these headers. Secret headers should be added manuall afterwards.
• If you have custom UI extensions, you need to reinstall them manually in the new space.

:memo: Changelog

Read the releases page for more information.

:scroll: License

This project is licensed under MIT license