Sitecore API catalog/Content Transfer API/Content transfer

Content transfer

API endpoints for content transfer operations.

Operations

Create a content transfer operation

Request

Creates a new operation to transfer one or more specified items from your source environment. You must specify a unique ID of your choice for the transfer, which you'll use later in the transfer workflow.

Make this request in your source environment.

Warning

If you reuse a previous transfer ID, the transfer operation associated with that ID will be overwritten (if it was not previously deleted using this API).

By default, a transfer will only include single items based on the paths you specify, and it will replace any duplicate items found in the destination environment. You can override these settings to include descendants or choose a different merge strategy as needed.

Security
bearerAuth
Body
required

The request body containing your transfer configuration and a unique transfer ID.

Configurationobject(TransferConfiguration)
Example:
{
  "DataTrees": [
    { … },
    { … }
  ],
  "Database": "master"
}
TransferIdstring, (uuid)

A universally unique identifier (UUID) representing the transfer. This is a value of your choice.

Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx and containing only hexadecimal characters (0-9, a-f).

Example:"00000000-0000-0000-0000-000000000000"
curl -i -X POST \
  https://your-environment.sitecorecloud.io/sitecore/api/content/transfer/v1/transfers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Configuration": {
      "DataTrees": [
        {
          "ItemPath": "/sitecore/content/Home",
          "Scope": "SingleItem",
          "MergeStrategy": "OverrideExistingItem"
        },
        {
          "ItemPath": "/sitecore/media library/Images",
          "Scope": "SingleItem",
          "MergeStrategy": "OverrideExistingItem"
        }
      ],
      "Database": "master"
    },
    "TransferId": "12345678-1234-1234-1234-123456789abc"
  }'

Responses

Content transfer creation was initiated successfully.

Response
No content