Copy API reference
The Copy API, or Cloud Clone, lets you copy existing datasets.
The Copy API, also known as Cloud Clone, allows you to make a copy of an existing dataset. It offers an alternative to exporting and importing a dataset.
Authentication
- All requests must be authenticated.
Base API server URL
Parameterized base URL
https://.api.sanity.io/{apiVersion}Variables
- apiVersionstringdefault:
"v2025-02-19"API version
Endpoints
Copy
/projects/{projectId}/datasets/{dataset}/copyThe Copy API, also known as Cloud Clone, allows you to make a copy of an existing dataset. It offers an alternative to exporting and importing a dataset. This feature is also available in the CLI. All requests to this endpoint must be authenticated.
Check the status of the copy operation
You can check the status of the copy operation by making a request to the Jobs API with the returned jobId.
Paid feature
This feature is part of our Advanced Dataset Management offering on the enterprise plan. Contact us if you need this feature and want to discuss this plan.
Request body application/json
The name of the new dataset. Must adhere to the dataset naming requirements.
Example:production-copyIf true, it skips document history while copying the dataset. This can reduce copy time on datasets with a large edit history. Check the retention period to find out how long a dataset's history is kept.
Responses
Returns details about the new copy job. Use the jobId with the Job API to check the status.
- datasetNamestring
The name of the source dataset.
Example:production - messagestring
A message indicating the status of the copy operation.
Example:Starting copying dataset production to production-copy... - aclModestring
The ACL mode to use for the new dataset.
Example:public - jobIdstring
The ID of the job that is running the copy operation.
Example:1234