Bulk job status

Bulk job status API

GET https://api.imagekit.io/v1/bulkJobs/:jobId

This endpoint allows you to get the status of a bulk operation e.g. copy or move folder API.

Path Parameters

Name	Type	Description
jobId	string	The jobId you get in the response of bulk job API e.g. copy folder or move folder API.

Headers

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

200 On success, you will receive a JSON-encoded response like below.

{
  "jobId": "job_id",
  "type": "COPY_FOLDER",
  "status": "Completed" // or "Pending"
}

Response structure and status code (application/JSON)

In case of an error, you will get an error code along with the error message. On success, you will receive a 200 status code with a JSON-encoded body.

Understanding the response

The JSON-encoded response will have the following properties:

Property name	Description
jobId	The jobId you get in the response of bulk job API e.g. copy folder or move folder API.
type	The type of operation, it could be either COPY_FOLDER or MOVE_FOLDER.
status	The current status of the job. It can be either: Pending - The job has been successfully submitted and is in progress. Completed - The job has been completed.

cURL

curl -X GET "https://api.imagekit.io/v1/bulkJobs/job_id" \
-u your_private_api_key:

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/"
});

var jobId = "job_id";
imagekit.getBulkJobStatus(jobId, 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/'
)

job_status = imagekit.get_bulk_job_status(job_id="job_id")

print("Bulk job status-", job_status, end="\n\n")

# Raw Response
print(job_status.response_metadata.raw)

# print the job's id
print(job_status.job_id)

# print the status
print(job_status.status)

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
);

$jobId = 'job_id';
// The jobId you get in the response of bulk job API e.g. copy folder or move folder API.

$bulkJobStatus = $imageKit->getBulkJobStatus($jobId);

echo("Bulk Job Status : " . json_encode($bulkJobStatus));

Java

String jobId = "job_id";
ResultBulkJobStatus resultBulkJobStatus = ImageKit.getInstance().getBulkJobStatus(jobId);

Ruby

imagekitio = ImageKitIo::Client.new("your_private_key", "your_public_key", "your_url_endpoint")
imagekitio.bulk_job_status(job_id: 'job_id')

Go

resp, err := ik.BulkJobStatus(ctx, "job_id")

.Net

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