---
title: "Extract a Zipped Object"
url: https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/stratus/extract-zipped-object/
description: "This page describes the method to execute circuits in your application with sample code snippets."
last_updated: 2026-09-09T10:45:38Z
service: CloudScale
type: general
related_links:
  - name: "Catalyst CloudScale"
    url: /en/cloud-scale/
  - name: "Stratus Help Documentation"
    url: /en/cloud-scale/help/stratus/introduction/
  - name: "Java SDK Documentation"
    url: /en/sdk/java/v1/cloud-scale/stratus/extract-zipped-object/
  - name: "Python SDK Documentation"
    url: /en/sdk/python/v1/cloud-scale/stratus/extract-zipped-object/
  - name: "iOS SDK Documentation"
    url: /en/sdk/ios/v2/cloud-scale/stratus/overview/
  - name: "Android SDK Documentation"
    url: /en/sdk/android/v2/cloud-scale/stratus/overview/
  - name: "Flutter SDK Documentation"
    url: /en/sdk/flutter/v2/cloud-scale/stratus/overview/
  - name: "REST API Documentation"
    url: /en/api/code-reference/cloud-scale/stratus/extract-object/#ExtractZippedObject
repository:
  name: "Repository"
  url: https://github.com/catalystbyzoho/zcatalyst-sdk-js
---

# Extract a Zipped Object

> **Notes:**

* Ensure you have installed the [required package](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/stratus/overview/#prerequisites) to use this SDK method.

* Since the extraction process occurs asynchronously, the time in which the entire process is completed is dependent on the size of the zip file that is being extracted.

#### Parameters Used

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th>Parameter Name</th>
      <th>Data Type</th>
      <th>Definition</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>`key`</td>
      <td>**String**</td>
      <td>A **mandatory** parameter. Will be the name of the zip file, you need to extract.</td>
    </tr>
    <tr>
      <td>`destPath`</td>
      <td>**String**</td>
      <td>A **mandatory** parameter. Will contain the complete [path information](https://docs.catalyst.zoho.com/en/cloud-scale/help/stratus/objects/introduction/#path) of the destination, where the extracted objects will be stored in the bucket.</td>
    </tr>
  </tbody>
</table>

You can use the `unzipObject()` SDK method to extract a zipped object in Stratus. 

```javascript
const res = await bucket.unzipObject("sample.zip","output/");
console.log(res);
```

#### Example of Expected Response

```json
{
  "key": "sample.zip",
  "destination": "output/",
  "task_id": "6963000000272049",
  "message": "Zip extract scheduled"
}
```

### Get Zip Extraction Status

The zip extraction process occurs asynchronously, and the time it takes to complete the extraction process is dependent on the size of the zip file.

#### Parameters Used

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th>Parameter Name</th>
      <th>Data Type</th>
      <th>Definition</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>`taskId`</td>
      <td>**String**</td>
      <td>This parameter will be returned in the response of the `unzipObject()` SDK method. It will contain the status of the extraction process.</td>
    </tr>
  </tbody>
</table>

You need to use the `taskId` parameter, in the `getUnzipStatus()` SDK method, to determine the status of the extraction. 

```javascript
const statusRes = await bucket.getUnzipStatus("sample.zip", 'taskId');
console.log(statusRes);
```

#### Example of Expected Response

```javascript
{
    "task_id": "6963000000272049",
    "status": "SUCCESS"
}
```