---
title: "Check Bucket Availability"
url: https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/stratus/check-bucket/
description: "This page lists the Node.js SDK method to check if the bucket exists in your project."
last_updated: 2026-09-08T11:07:33Z
service: Cloud Scale
type: general
related_links:
  - name: "Stratus Component Help Documentation"
    url: /en/cloud-scale/help/stratus/introduction
  - name: "Java SDK"
    url: /en/sdk/java/v1/cloud-scale/stratus/check-bucket/
  - name: "Python SDK"
    url: /en/sdk/python/v1/cloud-scale/stratus/check-bucket/
  - name: "JavaScript SDK Documentation"
    url: /en/sdk/javascript/v1/overview/
  - name: "iOS SDK"
    url: /en/sdk/ios/v2/cloud-scale/stratus/overview/
  - name: "Android SDK"
    url: /en/sdk/android/v2/cloud-scale/stratus/overview/
  - name: "Flutter SDK"
    url: /en/sdk/flutter/v2/cloud-scale/stratus/overview/
  - name: "REST API"
    url: /en/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets
---

# Check Bucket Availability

> **Note:** This SDK is currently in deprecation. Migrate to [JavaScript SDK](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/stratus/check-bucket-availability/) now.

Using the `headBucket()` SDK method, you can check the existence of a bucket in Stratus, and further check if the user has the relevant permissions to access the objects present in the bucket. The Stratus reference used in the below code snippet is the [component instance](https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/).

Possible responses when using this SDK:

* If the bucket exists and if the user has the relevant permissions to access the bucket, the response '**true**' will be returned.

* If the bucket does not exist, or if the user does not have permission to access the bucket, the response '**false**' will be returned.

**Parameters Used**

<table class="content-table">
	<thead>
		<tr>
			<th class="w20p">Parameter Name</th>
			<th class="w20p">Data Type</th>
      <th class="w60p">Definition</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>`bucketName`</td>
			<td>**String**</td>
			<td>A **Mandatory** parameter. Will hold the [unique name of the bucket](https://docs.catalyst.zoho.com/en/cloud-scale/help/stratus/buckets/name-bucket/#ideal-practices-to-name-a-bucket).</td>
		</tr>
		<tr>
			<td>`throwErr`</td>
			<td>**Boolean**</td>
			<td>An **Optional** parameter. If you set this parameter as "**true**", then it will throw an error when the bucket is not found in the project. The default value is "**false**"</td>
		</tr>
	</tbody>
</table>

```javascript
const headBucketResponse = await stratus.headBucket('bucketName'); // check the bucket is available in stratus
console.log(headBucketResponse);
```

**Possible Errors**

> **Note:** If you use the SDK with the `throw_err` parameter, and the bucket does not exist, or if you do not have sufficient permissions then you may encounter any of the errors listed below.

<table class="content-table">
	<thead>
		<tr>
			<th class="w30p">Error Code</th>
			<th class="w70p">Meaning</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>`404`</td>
			<td>Not Found. Bucket Not found in Stratus.</td>
		</tr>
		<tr>
			<td>`401`</td>
			<td>Unauthorized/Access Denied - User doesn't have permission to perform the particular operation.</td>
		</tr>
		<tr>
			<td>`403`</td>
			<td>Permission Denied - User does not have permission to access the particular bucket.</td>
		</tr>
	</tbody>
</table>