Copy file

Copy file API

POST https://api.imagekit.io/v1/files/copy

This will copy a file from one folder to another. Note: If any file at the destination has the same name as the source file, then the source file and its versions (if includeFileVersions is set to true) will be appended to the destination file version history.

Headers

Name	Type	Description
Authorization	string	base64 encoding of your_private_api_key: Note the colon in the end.

Request Body

Name	Type	Description
sourceFilePath	string	The full path of the file you want to copy. For example - /path/to/file.jpg
destinationPath	string	Full path to the folder you want to copy the above file into. For example - /folder/to/copy/into/
includeFileVersions	boolean	Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - false

204 Empty body is returned.

404 If no file is found at your sourceFilePath then a 404 response is returned.

{
     "message" : "No file found with filePath /path/to/file.jpg",
     "help" : "For support kindly contact us at [e-mail] .",
     "reason" : "SOURCE_FILE_MISSING" 
}

Response structure and status code

In case of an error, you will get an error code along with the error message. On success, you will receive a 204 status code with an empty body.

Access control and permissions

Read how access and permissions are affected by this operation here.

Examples

Here is the example request to understand the API usage.

cURL

curl -X POST "https://api.imagekit.io/v1/files/copy" \
-H 'Content-Type: application/json' \
-u your_private_key: -d '
{
	"sourceFilePath" : "/path/to/file.jpg",
	"destinationPath" : "/folder/to/copy/into/",
    "includeFileVersions" : true
}
'

Node.js

var ImageKit = require("imagekit");

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});

imagekit.copyFile({
     sourceFilePath: "/path/to/file.jpg",
     destinationPath: "/folder/to/copy/into/",
     includeFileVersions: false // optional
}, function(error, result) {
    if(error) console.log(error);
    else console.log(result);
});

Python

from imagekitio import ImageKit

imagekit = ImageKit(
    public_key='your_public_api_key',
    private_key='your_private_api_key',
    url_endpoint = 'https://ik.imagekit.io/your_imagekit_id/'
)

copy_file = imagekit.copy_file(options=CopyFileRequestOptions(source_file_path="/file.jpg",
                                       destination_path="/test",
                                       include_file_versions=True))

print("Copy file-", copy_file, end="\n\n")

# Raw Response
print(copy_file.response_metadata.raw)

PHP

use ImageKit\ImageKit;

$public_key = "your_public_api_key";
$your_private_key = "your_private_api_key";
$url_end_point = "https://ik.imagekit.io/your_imagekit_id";

$imageKit = new ImageKit(
    $public_key,
    $your_private_key,
    $url_end_point
);

$destinationPath = '/destination-folder';
$copyFile = $imageKit->copy([
    'sourceFilePath' => '/pah/to/file.jpg',
    'destinationPath' => '/folder/to/copy/into/',
    'includeFileVersions' => false
]);

echo("Copy File : " . json_encode($copyFile));

Java

CopyFileRequest copyFileRequest = new CopyFileRequest();
copyFileRequest.setSourceFilePath("/path/to/file.jpg");
copyFileRequest.setDestinationPath("/folder/to/copy/into/");
copyFileRequest.setIncludeFileVersions(true);
ResultNoContent resultNoContent = ImageKit.getInstance().copyFile(copyFileRequest);

Ruby

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.copy_file(
  source_file_path: '/pah/to/file.jpg',
  destination_path: '/folder/to/copy/into/',
  include_file_versions: false # optional
)

Go

resp, err := ik.Media.CopyFile(ctx, media.CopyFileParam{
    SourcePath: "/path/to/file.jpg",
    DestinationPath: "/folder/to/copy/into/",
    IncludeVersions: false, //optional
})

.Net

var imagekit = new ImageKit({
    publicKey : "your_public_api_key",
    privateKey : "your_private_api_key",
    urlEndpoint : "https://ik.imagekit.io/your_imagekit_id/"
});
CopyFileRequest cpyRequest = new CopyFileRequest
    {
        sourceFilePath = "/path/to/file.jpg",
        destinationPath = "/folder/to/copy/into/"
    };
ResultNoContent resultNoContent = imagekit.CopyFile(cpyRequest);