HTTP API Reference

Copy API reference

The Copy API, or Cloud Clone, lets you copy existing datasets.

The Copy API, also known as Cloud Clone, lets you make a copy of an existing dataset. It offers an alternative to exporting and importing a dataset.

Want to get started?

How to use Cloud Clone for datasets

Copy a dataset inside Sanity's infrastructure using either the CLI or HTTP API.

Authentication

All requests must be authenticated. The token needs the create grant on the sanity.project.datasets permission.

Base API server URL

Parameterized base URL

https://api.sanity.io/{apiVersion}

Variables

  • apiVersionstringdefault: "v2025-02-19"

    API version

Endpoints

Copy

put/projects/{projectId}/datasets/{dataset}/copy

The Copy API, also known as Cloud Clone, lets you 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.

Content releases in the copy

Unless you set skipContentReleases, content releases and their document versions are copied to the target dataset. Scheduled releases are unscheduled in the copy: they arrive with the active state and without a publishAt time.

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.

Path parameters

Request body application/json

  • targetDatasetstringrequired

    The name of the new dataset. Must adhere to the dataset naming requirements.

    Example:production-copy
  • skipHistorybooleandefault: false

    If 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.

  • skipContentReleasesbooleandefault: false

    If true, content releases aren't copied. This skips both the release documents and the document versions that belong to them. Copied releases count against your organization's release quota.

Responses

201

Returns details about the new copy job. Use the jobId with the Jobs 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 of the source dataset.

    Example:public
  • jobIdstring

    The ID of the job that is running the copy operation.

    Example:jacsfsmnxp

List copy jobs

get/projects/{projectId}/datasets/copy

Lists the dataset copy jobs for a project, newest first. The CLI uses this endpoint for sanity dataset copy --list.

The token needs the read grant on the sanity.project.datasets permission. Listing jobs doesn't require the Advanced Dataset Management feature.

To follow a single job, use the Jobs API with its id.

Path parameters

Query parameters

  • limitintegerdefault: 10

    The maximum number of jobs to return. Use a value of 255 or less: larger values wrap around, so 300 returns at most 44 jobs and 256 returns every job.

  • offsetintegerdefault: 0

    The number of jobs to skip, for paging through results. Use a value of 255 or less: larger values wrap around, so 256 starts from the first job again.

  • statestring

    A comma-separated list of job states to filter by. Valid states are pending, running, completed, failed, terminating, and terminated.

    Example:pending,running

Responses

200

Returns an array of copy jobs, newest first.

    items
    • idstring

      The job ID. Use it with the Jobs API to check the job's status.

      Example:jacsfsmnxp
    • statestring

      The current state of the job.

      Example:completed
    • authorsarray

      The IDs of the users who started the job. Jobs started by Sanity's own services list service.

      Show child attributes
      items
      • string
    • createdAtstring (date-time)
      Example:2026-10-20T12:00:00.000Z
    • updatedAtstring (date-time)
      Example:2026-10-20T12:20:00.000Z
    • sourceDatasetstring

      The name of the dataset being copied.

      Example:production
    • targetDatasetstring

      The name of the new dataset.

      Example:production-copy
    • withHistoryboolean

      Whether the copy includes document history. This is false when the job was started with skipHistory: true.

      Example:true