Stratus JavaScript SDK

# Stratus JavaScript SDK

# Overview

Stratus is the comprehensive object storage solution offered in the Catalyst Cloud Scale service. You can store data of any format in the form of Objects in containers called Buckets. Each Bucket and every individual object in the bucket has a secure Object URL and Bucket URL. You can perform CRUD, upload, and download operations on objects stored in the bucket.

### Prerequisites

You need to install the following packages to be able to use the Stratus SDK methods.

npm install @zcatalyst/stratus<br />

Info: Ensure that you have applied the required authentication configuration to use the SDK methods of this component.

### Import Requirement

You need to import the following module to use the Stratus SDK methods.

const { Stratus } = require('@zcatalyst/stratus');//Stratus module

### List of SDK Methods

The following table contains the list of SDK methods that can be used to perform Stratus operations through code.

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th>Category</th>
      <th>SDK Method</th>
      <th>Required Scope</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td rowspan="3">General Operations</td>
      <td>Check Stratus Instance</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Check Bucket Availability</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>List Buckets</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td rowspan="14">Bucket Operations</td>
      <td>Create Bucket Instance</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Get Bucket Details</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Get Bucket CORS</td>
     <td>Admin</td>
    </tr>
    <tr>
      <td>List Objects in a Bucket
        <ul>
          <li>List all objects by pagination</li>
          <li>List all objects through iteration</li>
        </ul>
      </td>
     <td>Admin</td>
    </tr>
    <tr>
      <td>Check Object Availability</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td rowspan="1">Download Object
        <ul>
          <li>Download an Object</li>
          <li>Download a Portion of the Object</li>
          <li>Download an Object Using Transfer Manager</li>
        </ul>
      </td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Generate Presigned URL to Download an Object</td>
      <td>Admin</td>
    </tr>
      <td rowspan="1">Upload Object
        <ul>
          <li>Upload Object as a Stream</li>
          <li>Upload Object as a String</li>
          <li>Upload Object with Options</li>
          <li>Upload Object With Extract Option</li>
          <li>Upload Object Using Multipart</li>
          <li>Upload an Object Using Transfer Manager</li>
        </ul>
      </td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Generate Presigned URL to Upload an Object</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Extract a Zipped Object In Stratus
        <ul>
          <li>Get Zip Extraction Status</li>
        </ul>
      </td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Copy Object</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Rename an Object</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Move an Object</td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Delete Object
        <ul>
          <li>Delete a Single Object</li>
          <li>Delete a Specific Version of an Object after a Specific Time</li>
          <li>Delete Multiple Objects</li>
          <li>Delete a Path in the Bucket</li>
          <li>Truncate Bucket</li>
        </ul>
      </td>
      <td>Admin</td>
    </tr>
    <tr>
      <td rowspan="4">Object Operations</td>
      <td>Create Object Instance</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>List Object Versions
        <ul>
          <li>List All Versions of an Object Through Pagination</li>
          <li>List All Versions of the Object Through Iteration</li>
        </ul>
      </td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Get Object Details
        <ul>
          <li>Get Details of All Objects</li>
          <li>Get Details of a Particular Version of the Object</li>
        </ul>
      </td>
      <td>Admin</td>
    </tr>
    <tr>
      <td>Put Object Meta Data</td>
     <td>Admin</td>
    </tr>
  </tbody>
</table>

Prerequisites

You need to install the following packages to be able to use the Stratus SDK methods.

copy
$npm install @zcatalyst/stratus

Info: Ensure that you have applied the required authentication configuration to use the SDK methods of this component.

Import Requirement

You need to import the following module to use the Stratus SDK methods.

copy

         const { Stratus } = require('@zcatalyst/stratus');//Stratus module

List of SDK Methods

The following table contains the list of SDK methods that can be used to perform Stratus operations through code.

Category	SDK Method	Required Scope
General Operations	Check Stratus Instance	Not required
	Check Bucket Availability	Not required
	List Buckets	Admin
Bucket Operations	Create Bucket Instance	Not required
	Get Bucket Details	Not required
	Get Bucket CORS	Admin
	List Objects in a Bucket List all objects by pagination List all objects through iteration	Admin
	Check Object Availability	Admin
	Download Object Download an Object Download a Portion of the Object Download an Object Using Transfer Manager	Not required
	Generate Presigned URL to Download an Object	Admin
	Upload Object Upload Object as a Stream Upload Object as a String Upload Object with Options Upload Object With Extract Option Upload Object Using Multipart Upload an Object Using Transfer Manager	Not required
	Generate Presigned URL to Upload an Object	Admin
	Extract a Zipped Object In Stratus Get Zip Extraction Status	Admin
	Copy Object	Admin
	Rename an Object	Admin
	Move an Object	Admin
	Delete Object Delete a Single Object Delete a Specific Version of an Object after a Specific Time Delete Multiple Objects Delete a Path in the Bucket Truncate Bucket	Admin
Object Operations	Create Object Instance	Not required
	List Object Versions List All Versions of an Object Through Pagination List All Versions of the Object Through Iteration	Admin
	Get Object Details Get Details of All Objects Get Details of a Particular Version of the Object	Admin
	Put Object Meta Data	Admin

Last Updated 2026-07-02 14:51:41 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit

Catalyst CloudScale Stratus Help Documentation Java SDK Documentation NodeJS SDK Documentation Python SDK Documentation Web SDK Documentation iOS SDK Documentation Android SDK Documentation Flutter SDK Documentation REST API Documentation

Modular JavaScript SDK

SDK Operations

Stratus JavaScript SDK

Prerequisites

Import Requirement

List of SDK Methods