Copy Dataset

Copy Dataset

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.8.x. To view documentation for other Kyvos versions, click here.

Overview

This API copies a Dataset to the specified destination folder.

Method: POST

Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/copy


Authorization

API Key: sessionid

This method authenticates requests using a session ID which acts like an API key.


BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.


Headers

Header Name

Type

Description

Possible Values

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–


Path Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Dataset that needs to be copied.

Note: If the Dataset name is provided, then sourceFolderName must also be provided.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as a Dataset name or a Dataset ID.

If by=name, provide the Dataset name in the name-or-id parameter.

If by=id, provide the Dataset ID in the name-or-id parameter.

The default value is name.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

targetDatasetName (Required)

String

Name of the Dataset that will be created as a copy.

–

targetFolderName

String

Name of the destination folder where the Dataset copy will be created. If you want to copy the Dataset to the root directory, specify [Root].

Note: If neither targetFolderName nor targetFolderId is provided, the API will create a copy of the Dataset in the root directory by default.

–

targetFolderId

String

ID of the target folder where the Dataset copy will be created.

–

sourceFolderName

String

Name of the folder containing the source Dataset.

Note: If the source Dataset is present in the root directory, specify [Root].

–


Responses

200 Success

{ "code": 0, "message": "Dataset copied successfully." }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error


Copyright Kyvos, Inc. 2026. All rights reserved.