Skip to content

Commit 35d15a3

Browse files
authored
Merge pull request #2037 from contentful/chore/embargoed-assets-dx-63
chore: update README with embargoed asset info [DX-63]
2 parents 71b9bc6 + 885763b commit 35d15a3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,21 @@ contentfulExport({
254254
})
255255
```
256256

257+
### Embargoed Assets
258+
259+
If a space is configured to use the [embargoed assets feature](https://www.contentful.com/help/media/embargoed-assets/), certain options will need to be set to use the export/import tooling. When exporting content, the `downloadAssets` option must be set to `true`. This will download the asset files to your local machine. Then, when importing content ([using `contentful-import`](https://github.com/contentful/contentful-import)), 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.
260+
261+
```javascript
262+
const contentfulExport = require('contentful-export')
263+
264+
const options = {
265+
spaceId: '<space_id>',
266+
managementToken: '<content_management_api_key>',
267+
downloadAssets: true
268+
}
269+
270+
contentfulExport(options)
271+
```
257272

258273
## :card_file_box: Exported data structure
259274

0 commit comments

Comments
 (0)