Complete API Reference | Tigris Object Storage Documentation

Skip to main content

On this page

API reference for @tigrisdata/storage v3.16.0.

For usage examples and guides, see Using the SDK.

Contents [​](/content/docs/sdks/tigris/api/#contents "Direct link to Contents"/index.html)

• Client API
• Object Operations
• Presigned URLs
• Bucket Management
• Bucket Configuration
• Snapshots
• Multipart Upload
• Client Upload Handling
• Statistics
• Common Types

Client API [​](/content/docs/sdks/tigris/api/#client-api "Direct link to Client API"/index.html)

Functions and types exported from @tigrisdata/storage/client for browser-side uploads.

upload [​](/content/docs/sdks/tigris/api/#upload "Direct link to upload"/index.html)

function upload(

name: string,

data: File | Blob,

options?: UploadOptions,

): Promise<TigrisStorageResponse<UploadResponse, Error>>;

executeWithConcurrency [​](/content/docs/sdks/tigris/api/#executewithconcurrency "Direct link to executewithconcurrency"/index.html)

Executes an array of task functions with a concurrency limit. Each task is a function that returns a Promise.

function executeWithConcurrency<T>(

tasks: (() => Promise<T>)[],

concurrency: number,

): Promise<T[]>;

Types [​](/content/docs/sdks/tigris/api/#types "Direct link to Types"/index.html)

UploadOptions [​](/content/docs/sdks/tigris/api/#uploadoptions "Direct link to uploadoptions"/index.html)

type UploadOptions = {

access?: "public" | "private";

addRandomSuffix?: boolean;

allowOverwrite?: boolean;

contentType?: string;

contentDisposition?: "attachment" | "inline";

url?: string;

multipart?: boolean;

partSize?: number;

/**

* Maximum number of concurrent part uploads for multipart uploads

* @default 4

*/

concurrency?: number;

onUploadProgress?: (progress: UploadProgress) => void;

};

UploadProgress [​](/content/docs/sdks/tigris/api/#uploadprogress "Direct link to uploadprogress"/index.html)

type UploadProgress = {

loaded: number;

total: number;

percentage: number;

};

UploadResponse [​](/content/docs/sdks/tigris/api/#uploadresponse "Direct link to uploadresponse"/index.html)

type UploadResponse = {

contentDisposition?: string;

contentType?: string;

modified: Date;

name: string;

size: number;

url: string;

};

Object Operations [​](/content/docs/sdks/tigris/api/#object-operations "Direct link to Object Operations"/index.html)

Create, read, update, and delete objects in a bucket.

put [​](/content/docs/sdks/tigris/api/#put "Direct link to put"/index.html)

function put(

path: string,

body: string | ReadableStream | Blob | Buffer,

options?: PutOptions,

): Promise<TigrisStorageResponse<PutResponse, Error>>;

get [​](/content/docs/sdks/tigris/api/#get "Direct link to get"/index.html)

Overloads:

function get(

path: string,

format: "string",

options: GetOptions & {

includeMetadata: true;

},

): Promise<TigrisStorageResponse<GetResponseWithMetadata<string>, Error>>;

function get(

path: string,

format: "file",

options: GetOptions & {

includeMetadata: true;

},

): Promise<TigrisStorageResponse<GetResponseWithMetadata<File>, Error>>;

function get(

path: string,

format: "stream",

options: GetOptions & {

includeMetadata: true;

},

): Promise<

TigrisStorageResponse<GetResponseWithMetadata<ReadableStream>, Error>

>;

function get(

path: string,

format: "string",

options?: GetOptions,

): Promise<TigrisStorageResponse<string, Error>>;

function get(

path: string,

format: "file",

options?: GetOptions,

): Promise<TigrisStorageResponse<File, Error>>;

function get(

path: string,

format: "stream",

options?: GetOptions,

): Promise<TigrisStorageResponse<ReadableStream, Error>>;

head [​](/content/docs/sdks/tigris/api/#head "Direct link to head"/index.html)

function head(

path: string,

options?: HeadOptions,

): Promise<TigrisStorageResponse<HeadResponse | undefined, Error>>;

list [​](/content/docs/sdks/tigris/api/#list "Direct link to list"/index.html)

function list(

options?: ListOptions,

): Promise<TigrisStorageResponse<ListResponse, Error>>;

remove [​](/content/docs/sdks/tigris/api/#remove "Direct link to remove"/index.html)

function remove(

path: string,

options?: RemoveOptions,

): Promise<TigrisStorageResponse<void, Error>>;

updateObject [​](/content/docs/sdks/tigris/api/#updateobject "Direct link to updateobject"/index.html)

Deprecated Use setObjectAccess to change object ACLs, or the dedicated rename helper to change an object's key. updateObject will be removed in a future major version.

function updateObject(

path: string,

options?: UpdateObjectOptions,

): Promise<TigrisStorageResponse<UpdateObjectResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-1 "Direct link to Types"/index.html)

PutOptions [​](/content/docs/sdks/tigris/api/#putoptions "Direct link to putoptions"/index.html)

type PutOptions = {

access?: "public" | "private";

addRandomSuffix?: boolean;

allowOverwrite?: boolean;

contentType?: string;

contentDisposition?: "attachment" | "inline";

metadata?: Record<string, string>;

multipart?: boolean;

partSize?: number;

queueSize?: number;

abortController?: AbortController;

onUploadProgress?: PutOnUploadProgress;

config?: TigrisStorageConfig;

};

PutResponse [​](/content/docs/sdks/tigris/api/#putresponse "Direct link to putresponse"/index.html)

type PutResponse = {

contentDisposition: string | undefined;

contentType: string | undefined;

etag: string;

metadata: Record<string, string> | undefined;

modified: Date;

path: string;

size: number;

url: string;

};

PutOnUploadProgress [​](/content/docs/sdks/tigris/api/#putonuploadprogress "Direct link to putonuploadprogress"/index.html)

type PutOnUploadProgress = ({

loaded,

total,

percentage,

}: {

loaded: number;

total: number;

percentage: number;

}) => void;

GetOptions [​](/content/docs/sdks/tigris/api/#getoptions "Direct link to getoptions"/index.html)

type GetOptions = {

config?: TigrisStorageConfig;

contentDisposition?: "attachment" | "inline";

contentType?: string;

encoding?: string;

/**

* When true, `get` returns `{ body, metadata }` instead of the bare

* body, surfacing the object's etag, content metadata, user metadata,

* and (when `range` is used) `Content-Range` — all read from the same

* S3 response, no extra round-trip.

*/

includeMetadata?: boolean;

/**

* Byte range to read. Both bounds are inclusive and 0-based, matching

* the HTTP `Range: bytes=…` semantics. Omit `end` to read from `start`

* to the end of the object. A range that falls entirely outside the

* object returns an error (HTTP 416). The returned body is the partial

* content only.

*/

range?: {

start: number;

end?: number;

};

snapshotVersion?: string;

versionId?: string;

};

body, surfacing the object's etag, content metadata, user metadata, and (when range is used) Content-Range — all read from the same S3 response, no extra round-trip. | | range | \{ start: number; end?: number; \} | No | Byte range to read. Both bounds are inclusive and 0-based, matching the HTTP Range: bytes=… semantics. Omit end to read from start to the end of the object. A range that falls entirely outside the object returns an error (HTTP 416). The returned body is the partial content only. | | snapshotVersion | string | No | | | versionId | string | No | |

GetResponse [​](/content/docs/sdks/tigris/api/#getresponse "Direct link to getresponse"/index.html)

type GetResponse = string | File | ReadableStream;

HeadOptions [​](/content/docs/sdks/tigris/api/#headoptions "Direct link to headoptions"/index.html)

type HeadOptions = {

snapshotVersion?: string;

versionId?: string;

config?: TigrisStorageConfig;

};

HeadResponse [​](/content/docs/sdks/tigris/api/#headresponse "Direct link to headresponse"/index.html)

type HeadResponse = {

contentDisposition: string;

contentType: string;

etag: string;

metadata: Record<string, string>;

modified: Date;

path: string;

size: number;

url: string;

};

ListOptions [​](/content/docs/sdks/tigris/api/#listoptions "Direct link to listoptions"/index.html)

type ListOptions = {

delimiter?: string;

prefix?: string;

limit?: number;

paginationToken?: string;

snapshotVersion?: string;

source?: "tigris" | "shadow";

config?: TigrisStorageConfig;

};

ListItem [​](/content/docs/sdks/tigris/api/#listitem "Direct link to listitem"/index.html)

type ListItem = {

id: string;

name: string;

size: number;

lastModified: Date;

etag: string;

};

ListResponse [​](/content/docs/sdks/tigris/api/#listresponse "Direct link to listresponse"/index.html)

type ListResponse = {

items: ListItem[];

commonPrefixes: string[];

paginationToken: string | undefined;

hasMore: boolean;

};

RemoveOptions [​](/content/docs/sdks/tigris/api/#removeoptions "Direct link to removeoptions"/index.html)

type RemoveOptions = {

config?: TigrisStorageConfig;

versionId?: string;

};

UpdateObjectOptions [​](/content/docs/sdks/tigris/api/#updateobjectoptions "Direct link to updateobjectoptions"/index.html)

type UpdateObjectOptions = {

config?: TigrisStorageConfig;

key?: string;

access?: "public" | "private";

};

UpdateObjectResponse [​](/content/docs/sdks/tigris/api/#updateobjectresponse "Direct link to updateobjectresponse"/index.html)

type UpdateObjectResponse = {

path: string;

};

Presigned URLs [​](/content/docs/sdks/tigris/api/#presigned-urls "Direct link to Presigned URLs"/index.html)

Generate presigned URLs for time-limited access to objects.

getPresignedUrl [​](/content/docs/sdks/tigris/api/#getpresignedurl "Direct link to getpresignedurl"/index.html)

function getPresignedUrl(

path: string,

options: GetPresignedUrlOptions,

): Promise<TigrisStorageResponse<GetPresignedUrlResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-2 "Direct link to Types"/index.html)

GetPresignedUrlOptions [​](/content/docs/sdks/tigris/api/#getpresignedurloptions "Direct link to getpresignedurloptions"/index.html)

type GetPresignedUrlOptions = {

/**

* The access key ID to use for the presigned URL.

* If not provided, the access key ID from the config will be used.

*/

accessKeyId?: string;

/**

* The expiration time of the presigned URL in seconds.

* Default is 3600 seconds (1 hour).

*/

expiresIn?: number;

/**

* Snapshot version to read from. When set, the presigned URL is

* pinned to the object version that was current at the time of the

* snapshot.

*

* The gateway's presign endpoint accepts a literal object versionId

* (not a snapshot version), so this function resolves the snapshot

* to the correct versionId client-side: lists the key's versions

* (and delete markers) and selects the newest entry with

* `versionId <= snapshotVersion`.

*

* Only valid with `operation: 'get'`. Returns an error if the object

* did not exist at the snapshot time (either never written, or

* deleted before the snapshot).

*/

snapshotVersion?: string;

config?: TigrisStorageConfig;

} & MethodOrOperation;

pinned to the object version that was current at the time of the snapshot.

The gateway's presign endpoint accepts a literal object versionId (not a snapshot version), so this function resolves the snapshot to the correct versionId client-side: lists the key's versions (and delete markers) and selects the newest entry with versionId <= snapshotVersion.

Only valid with operation: 'get'. Returns an error if the object did not exist at the snapshot time (either never written, or deleted before the snapshot). | | config | TigrisStorageConfig | No | |

GetPresignedUrlResponse [​](/content/docs/sdks/tigris/api/#getpresignedurlresponse "Direct link to getpresignedurlresponse"/index.html)

type GetPresignedUrlResponse = {

url: string;

expiresIn: number;

} & MethodOrOperation;

GetPresignedUrlOperation [​](/content/docs/sdks/tigris/api/#getpresignedurloperation "Direct link to getpresignedurloperation"/index.html)

type GetPresignedUrlOperation = "get" | "put";

MethodOrOperation [​](/content/docs/sdks/tigris/api/#methodoroperation "Direct link to methodoroperation"/index.html)

type MethodOrOperation =

| {

method: GetPresignedUrlOperation;

operation?: never;

}

| {

operation: GetPresignedUrlOperation;

method?: never;

};

Bucket Management [​](/content/docs/sdks/tigris/api/#bucket-management "Direct link to Bucket Management"/index.html)

Create, list, update, and delete buckets.

createBucket [​](/content/docs/sdks/tigris/api/#createbucket "Direct link to createbucket"/index.html)

function createBucket(

bucketName: string,

options?: CreateBucketOptions,

): Promise<TigrisStorageResponse<CreateBucketResponse, Error>>;

getBucketInfo [​](/content/docs/sdks/tigris/api/#getbucketinfo "Direct link to getbucketinfo"/index.html)

function getBucketInfo(

bucketName: string,

options?: GetBucketInfoOptions,

): Promise<TigrisStorageResponse<BucketInfoResponse, Error>>;

listBuckets [​](/content/docs/sdks/tigris/api/#listbuckets "Direct link to listbuckets"/index.html)

function listBuckets(

options?: ListBucketsOptions,

): Promise<TigrisStorageResponse<ListBucketsResponse, Error>>;

updateBucket [​](/content/docs/sdks/tigris/api/#updatebucket "Direct link to updatebucket"/index.html)

function updateBucket(

bucketName: string,

options?: UpdateBucketOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

removeBucket [​](/content/docs/sdks/tigris/api/#removebucket "Direct link to removebucket"/index.html)

function removeBucket(

bucketName: string,

options?: RemoveBucketOptions,

): Promise<TigrisStorageResponse<void, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-3 "Direct link to Types"/index.html)

CreateBucketOptions [​](/content/docs/sdks/tigris/api/#createbucketoptions "Direct link to createbucketoptions"/index.html)

type CreateBucketOptions = {

enableSnapshot?: boolean;

sourceBucketName?: string;

sourceBucketSnapshot?: string;

access?: "public" | "private";

defaultTier?: StorageClass;

locations?: BucketLocations;

enableDirectoryListing?: boolean;

allowObjectAcl?: boolean;

config?: Omit<TigrisStorageConfig, "bucket">;

};

CreateBucketResponse [​](/content/docs/sdks/tigris/api/#createbucketresponse "Direct link to createbucketresponse"/index.html)

type CreateBucketResponse = {

isSnapshotEnabled: boolean;

hasForks: boolean;

sourceBucketName?: string;

sourceBucketSnapshot?: string;

};

GetBucketInfoOptions [​](/content/docs/sdks/tigris/api/#getbucketinfooptions "Direct link to getbucketinfooptions"/index.html)

type GetBucketInfoOptions = {

config?: TigrisStorageConfig;

};

BucketInfoResponse [​](/content/docs/sdks/tigris/api/#bucketinforesponse "Direct link to bucketinforesponse"/index.html)

type BucketInfoResponse = {

/**

* @deprecated Use `locations` instead — it carries the same data with

* a structured `BucketLocations` shape that distinguishes `global` /

* `multi` / `single` / `dual`. `regions` will be removed in the next

* major version.

*

* Note: for region codes the SDK does not recognize, `regions` passes

* the raw value through (e.g. `['mars']`) while `locations` falls back

* defensively to `{ type: 'global' }`. The two fields can therefore

* disagree when the gateway returns a region code newer than the SDK.

*/

regions: string[];

locations: BucketLocations;

isSnapshotEnabled: boolean;

forkInfo:

| {

hasChildren: boolean;

parents: Array<{

bucketName: string;

forkCreatedAt: Date;

snapshot: string;

snapshotCreatedAt: Date;

}>;

}

| undefined;

settings: {

allowObjectAcl: boolean;

defaultTier: StorageClass;

lifecycleRules?: BucketLifecycleRule[];

dataMigration?: Omit<BucketMigration, "enabled">;

/**

* @deprecated Use `lifecycleRules` instead. This field is no longer

* populated — read the rule with only `expiration` (no transition,

* no filter) from `lifecycleRules` if you need the bucket-wide TTL.

*/

ttlConfig?: BucketTtl;

customDomain?: string;

softDelete:

| {

enabled: true;

retentionDays: number;

}

| {

enabled: false;

};

/**

* @deprecated Use `softDelete` instead.

*/

deleteProtection: boolean;

corsRules: BucketCorsRule[];

additionalHeaders?: GetBucketInfoApiResponseBody["additional_http_headers"];

notifications?: BucketNotification;

};

sizeInfo: {

numberOfObjects: number | undefined;

size: number | undefined;

numberOfObjectsAllVersions: number | undefined;

};

};

a structured BucketLocations shape that distinguishes global / multi / single / dual. regions will be removed in the next major version.

Note: for region codes the SDK does not recognize, regions passes the raw value through (e.g. ['mars']) while locations falls back defensively to { type: 'global' }. The two fields can therefore disagree when the gateway returns a region code newer than the SDK. | | locations | BucketLocations | Yes | | | isSnapshotEnabled | boolean | Yes | | | forkInfo | \{ hasChildren: boolean; parents: Array<\{ bucketName: string; forkCreatedAt: Date; snapshot: string; snapshotCreatedAt: Date; \}>; \} \| undefined | Yes | | | settings | \{ allowObjectAcl: boolean; defaultTier: StorageClass; lifecycleRules?: BucketLifecycleRule[]; dataMigration?: Omit<BucketMigration, 'enabled'>; /** * @deprecated UselifecycleRulesinstead. This field is no longer * populated — read the rule with onlyexpiration(no transition, * no filter) fromlifecycleRulesif you need the bucket-wide TTL. */ ttlConfig?: BucketTtl; customDomain?: string; softDelete: \{ enabled: true; retentionDays: number; \} \| \{ enabled: false; \}; /** * @deprecated UsesoftDelete instead. */ deleteProtection: boolean; corsRules: BucketCorsRule[]; additionalHeaders?: GetBucketInfoApiResponseBody['additional_http_headers']; notifications?: BucketNotification; \} | Yes | | | sizeInfo | \{ numberOfObjects: number \| undefined; size: number \| undefined; numberOfObjectsAllVersions: number \| undefined; \} | Yes | |

ListBucketsOptions [​](/content/docs/sdks/tigris/api/#listbucketsoptions "Direct link to listbucketsoptions"/index.html)

type ListBucketsOptions = {

config?: TigrisStorageConfig;

paginationToken?: string;

limit?: number;

deleted?: boolean;

};

ListBucketsResponse [​](/content/docs/sdks/tigris/api/#listbucketsresponse "Direct link to listbucketsresponse"/index.html)

type ListBucketsResponse = {

buckets: Bucket[];

owner?: BucketOwner;

paginationToken?: string;

};

Bucket [​](/content/docs/sdks/tigris/api/#bucket "Direct link to bucket"/index.html)

type Bucket = {

name: string;

creationDate: Date;

regions?: string[];

type?: BucketType;

visibility?: BucketVisibility;

softDeleteInfo?: {

enabled: boolean;

retentionDays: number;

};

forkInfo?: {

hasChildren: boolean;

parents: Array<{

bucketName: string;

forkCreatedAt: Date;

snapshot: string;

snapshotCreatedAt: Date;

}>;

};

};

BucketOwner [​](/content/docs/sdks/tigris/api/#bucketowner "Direct link to bucketowner"/index.html)

type BucketOwner = {

name: string;

id: string;

};

UpdateBucketOptions [​](/content/docs/sdks/tigris/api/#updatebucketoptions "Direct link to updatebucketoptions"/index.html)

type UpdateBucketOptions = {

access?: "public" | "private";

allowObjectAcl?: boolean;

disableDirectoryListing?: boolean;

locations?: BucketLocations;

cacheControl?: string;

customDomain?: string;

enableAdditionalHeaders?: boolean;

softDelete?:

| {

enabled: true;

retentionDays: number;

}

| {

enabled: false;

};

/**

* @deprecated Use `softDelete` instead.

*/

enableDeleteProtection?: boolean;

config?: Omit<TigrisStorageConfig, "bucket">;

};

UpdateBucketResponse [​](/content/docs/sdks/tigris/api/#updatebucketresponse "Direct link to updatebucketresponse"/index.html)

type UpdateBucketResponse = {

bucket: string;

updated: boolean;

};

RemoveBucketOptions [​](/content/docs/sdks/tigris/api/#removebucketoptions "Direct link to removebucketoptions"/index.html)

type RemoveBucketOptions = {

force?: boolean;

config?: TigrisStorageConfig;

};

Bucket Configuration [​](/content/docs/sdks/tigris/api/#bucket-configuration "Direct link to Bucket Configuration"/index.html)

Configure CORS, lifecycle rules, TTL, migration, and notifications for a bucket.

setBucketCors [​](/content/docs/sdks/tigris/api/#setbucketcors "Direct link to setbucketcors"/index.html)

function setBucketCors(

bucketName: string,

options?: SetBucketCorsOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

setBucketLifecycle [​](/content/docs/sdks/tigris/api/#setbucketlifecycle "Direct link to setbucketlifecycle"/index.html)

function setBucketLifecycle(

bucketName: string,

options?: SetBucketLifecycleOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

setBucketTtl [​](/content/docs/sdks/tigris/api/#setbucketttl "Direct link to setbucketttl"/index.html)

function setBucketTtl(

bucketName: string,

options?: SetBucketTtlOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

setBucketMigration [​](/content/docs/sdks/tigris/api/#setbucketmigration "Direct link to setbucketmigration"/index.html)

function setBucketMigration(

bucketName: string,

options?: SetBucketMigrationOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

setBucketNotifications [​](/content/docs/sdks/tigris/api/#setbucketnotifications "Direct link to setbucketnotifications"/index.html)

Configure webhook notifications for object events on a bucket.

Scenarios:

1. If notificationConfig is empty ({}), sends it as-is to clear notifications.

2. If only enabled is provided, fetches the existing config and merges with the new enabled value. Errors if no existing config is found.

3. If config is provided without enabled, fetches existing config and merges, retaining the existing enabled value.

4. url is validated when provided (must be a valid http/https URL).

5. auth.username and auth.password are validated when provided.

6. auth.token is validated when provided.

7. auth.token and auth.username/auth.password cannot be provided together.

8. override replaces the existing config when true. When false (default), merges with the existing config.

function setBucketNotifications(

bucketName: string,

options: SetBucketNotificationsOptions,

): Promise<TigrisStorageResponse<UpdateBucketResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-4 "Direct link to Types"/index.html)

SetBucketCorsOptions [​](/content/docs/sdks/tigris/api/#setbucketcorsoptions "Direct link to setbucketcorsoptions"/index.html)

type SetBucketCorsOptions = {

config?: Omit<TigrisStorageConfig, "bucket">;

override?: boolean;

rules: BucketCorsRule[];

};

SetBucketLifecycleOptions [​](/content/docs/sdks/tigris/api/#setbucketlifecycleoptions "Direct link to setbucketlifecycleoptions"/index.html)

type SetBucketLifecycleOptions = {

lifecycleRules: BucketLifecycleRule[];

config?: Omit<TigrisStorageConfig, "bucket">;

};

SetBucketTtlOptions [​](/content/docs/sdks/tigris/api/#setbucketttloptions "Direct link to setbucketttloptions"/index.html)

type SetBucketTtlOptions = {

ttlConfig?: BucketTtl;

config?: Omit<TigrisStorageConfig, "bucket">;

};

SetBucketMigrationOptions [​](/content/docs/sdks/tigris/api/#setbucketmigrationoptions "Direct link to setbucketmigrationoptions"/index.html)

type SetBucketMigrationOptions = {

dataMigration?: BucketMigration;

config?: Omit<TigrisStorageConfig, "bucket">;

};

SetBucketNotificationsOptions [​](/content/docs/sdks/tigris/api/#setbucketnotificationsoptions "Direct link to setbucketnotificationsoptions"/index.html)

type SetBucketNotificationsOptions = {

config?: Omit<TigrisStorageConfig, "bucket">;

notificationConfig: BucketNotification;

override?: boolean;

};

BucketCorsRule [​](/content/docs/sdks/tigris/api/#bucketcorsrule "Direct link to bucketcorsrule"/index.html)

type BucketCorsRule = {

allowedOrigins: string | string[];

allowedMethods?: string | string[];

allowedHeaders?: string | string[];

exposeHeaders?: string | string[];

maxAge?: number;

};

BucketLifecycleRule [​](/content/docs/sdks/tigris/api/#bucketlifecyclerule "Direct link to bucketlifecyclerule"/index.html)

A bucket lifecycle rule. A rule can have at most one transition (top-level storageClass + days/date) and/or one expiration, optionally scoped to a key prefix via filter.prefix. At least one of transition or expiration must be present.

/**

* A bucket lifecycle rule. A rule can have at most one transition

* (top-level `storageClass` + `days`/`date`) and/or one `expiration`,

* optionally scoped to a key prefix via `filter.prefix`. At least one

* of transition or expiration must be present.

*/

type BucketLifecycleRule = {

id?: string;

enabled?: boolean;

storageClass?: Exclude<StorageClass, "STANDARD">;

days?: number;

date?: string;

expiration?: BucketLifecycleExpiration;

filter?: BucketLifecycleFilter;

};

BucketTtl [​](/content/docs/sdks/tigris/api/#bucketttl "Direct link to bucketttl"/index.html)

Bucket-wide TTL configuration. Kept for back-compat with setBucketTtl, which manages a lifecycle rule with only expiration (no transition, no filter). New code should configure expirations via BucketLifecycleRule.expiration on setBucketLifecycle instead. This shape is expected to be removed in the next major version.

/**

* Bucket-wide TTL configuration. Kept for back-compat with `setBucketTtl`,

* which manages a lifecycle rule with only `expiration` (no transition,

* no filter). New code should configure expirations via

* `BucketLifecycleRule.expiration` on `setBucketLifecycle` instead. This

* shape is expected to be removed in the next major version.

*/

type BucketTtl = {

id?: string;

enabled?: boolean;

days?: number;

date?: string;

};

BucketMigration [​](/content/docs/sdks/tigris/api/#bucketmigration "Direct link to bucketmigration"/index.html)

type BucketMigration = {

enabled: boolean;

accessKey?: string;

secretKey?: string;

region?: string;

name?: string;

endpoint?: string;

writeThrough?: boolean;

};

BucketNotification [​](/content/docs/sdks/tigris/api/#bucketnotification "Direct link to bucketnotification"/index.html)

type BucketNotification =

| BucketNotificationBase

| BucketNotificationBasicAuth

| BucketNotificationTokenAuth;

BucketNotificationBase [​](/content/docs/sdks/tigris/api/#bucketnotificationbase "Direct link to bucketnotificationbase"/index.html)

type BucketNotificationBase = {

enabled?: boolean;

url?: string;

filter?: string;

};

BucketNotificationBasicAuth [​](/content/docs/sdks/tigris/api/#bucketnotificationbasicauth "Direct link to bucketnotificationbasicauth"/index.html)

type BucketNotificationBasicAuth = BucketNotificationBase & {

auth: {

username: string;

password: string;

token?: never;

};

};

BucketNotificationTokenAuth [​](/content/docs/sdks/tigris/api/#bucketnotificationtokenauth "Direct link to bucketnotificationtokenauth"/index.html)

type BucketNotificationTokenAuth = BucketNotificationBase & {

auth: {

token: string;

username?: never;

password?: never;

};

};

Snapshots [​](/content/docs/sdks/tigris/api/#snapshots "Direct link to Snapshots"/index.html)

Create and list bucket snapshots.

createBucketSnapshot [​](/content/docs/sdks/tigris/api/#createbucketsnapshot "Direct link to createbucketsnapshot"/index.html)

Overloads:

function createBucketSnapshot(

options?: CreateBucketSnapshotOptions,

): Promise<TigrisStorageResponse<CreateBucketSnapshotResponse, Error>>;

function createBucketSnapshot(

sourceBucketName?: string,

options?: CreateBucketSnapshotOptions,

): Promise<TigrisStorageResponse<CreateBucketSnapshotResponse, Error>>;

listBucketSnapshots [​](/content/docs/sdks/tigris/api/#listbucketsnapshots "Direct link to listbucketsnapshots"/index.html)

Overloads:

function listBucketSnapshots(

options?: ListBucketSnapshotsOptions,

): Promise<TigrisStorageResponse<ListBucketSnapshotsResponse, Error>>;

function listBucketSnapshots(

sourceBucketName?: string,

options?: ListBucketSnapshotsOptions,

): Promise<TigrisStorageResponse<ListBucketSnapshotsResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-5 "Direct link to Types"/index.html)

CreateBucketSnapshotOptions [​](/content/docs/sdks/tigris/api/#createbucketsnapshotoptions "Direct link to createbucketsnapshotoptions"/index.html)

type CreateBucketSnapshotOptions = {

name?: string;

config?: Omit<TigrisStorageConfig, "bucket">;

};

CreateBucketSnapshotResponse [​](/content/docs/sdks/tigris/api/#createbucketsnapshotresponse "Direct link to createbucketsnapshotresponse"/index.html)

type CreateBucketSnapshotResponse = {

snapshotVersion: string;

};

ListBucketSnapshotsOptions [​](/content/docs/sdks/tigris/api/#listbucketsnapshotsoptions "Direct link to listbucketsnapshotsoptions"/index.html)

type ListBucketSnapshotsOptions = {

config?: Omit<TigrisStorageConfig, "bucket">;

paginationToken?: string;

limit?: number;

};

ListBucketSnapshotsResponse [​](/content/docs/sdks/tigris/api/#listbucketsnapshotsresponse "Direct link to listbucketsnapshotsresponse"/index.html)

type ListBucketSnapshotsResponse = {

snapshots: BucketSnapshot[];

paginationToken?: string;

};

Multipart Upload [​](/content/docs/sdks/tigris/api/#multipart-upload "Direct link to Multipart Upload"/index.html)

Low-level multipart upload operations for advanced use cases.

initMultipartUpload [​](/content/docs/sdks/tigris/api/#initmultipartupload "Direct link to initmultipartupload"/index.html)

function initMultipartUpload(

path: string,

options?: InitMultipartUploadOptions,

): Promise<TigrisStorageResponse<InitMultipartUploadResponse, Error>>;

getPartsPresignedUrls [​](/content/docs/sdks/tigris/api/#getpartspresignedurls "Direct link to getpartspresignedurls"/index.html)

function getPartsPresignedUrls(

path: string,

parts: number[],

uploadId: string,

options?: GetPartsPresignedUrlsOptions,

): Promise<TigrisStorageResponse<GetPartsPresignedUrlsResponse, Error>>;

completeMultipartUpload [​](/content/docs/sdks/tigris/api/#completemultipartupload "Direct link to completemultipartupload"/index.html)

function completeMultipartUpload(

path: string,

uploadId: string,

partIds: Array<{

[key: number]: string;

}>,

options?: CompleteMultipartUploadOptions,

): Promise<TigrisStorageResponse<CompleteMultipartUploadResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-6 "Direct link to Types"/index.html)

InitMultipartUploadOptions [​](/content/docs/sdks/tigris/api/#initmultipartuploadoptions "Direct link to initmultipartuploadoptions"/index.html)

type InitMultipartUploadOptions = {

config?: TigrisStorageConfig;

};

InitMultipartUploadResponse [​](/content/docs/sdks/tigris/api/#initmultipartuploadresponse "Direct link to initmultipartuploadresponse"/index.html)

type InitMultipartUploadResponse = {

uploadId: string;

};

GetPartsPresignedUrlsOptions [​](/content/docs/sdks/tigris/api/#getpartspresignedurlsoptions "Direct link to getpartspresignedurlsoptions"/index.html)

type GetPartsPresignedUrlsOptions = {

config?: TigrisStorageConfig;

};

GetPartsPresignedUrlsResponse [​](/content/docs/sdks/tigris/api/#getpartspresignedurlsresponse "Direct link to getpartspresignedurlsresponse"/index.html)

type GetPartsPresignedUrlsResponse = Array<{

part: number;

url: string;

}>;

CompleteMultipartUploadOptions [​](/content/docs/sdks/tigris/api/#completemultipartuploadoptions "Direct link to completemultipartuploadoptions"/index.html)

type CompleteMultipartUploadOptions = {

config?: TigrisStorageConfig;

};

CompleteMultipartUploadResponse [​](/content/docs/sdks/tigris/api/#completemultipartuploadresponse "Direct link to completemultipartuploadresponse"/index.html)

type CompleteMultipartUploadResponse = {

path: string;

url: string;

};

Client Upload Handling [​](/content/docs/sdks/tigris/api/#client-upload-handling "Direct link to Client Upload Handling"/index.html)

Server-side handler for processing client upload requests (pairs with the Client API upload function).

handleClientUpload [​](/content/docs/sdks/tigris/api/#handleclientupload "Direct link to handleclientupload"/index.html)

function handleClientUpload(

request: ClientUploadRequest,

config?: TigrisStorageConfig,

): Promise<TigrisStorageResponse<unknown, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-7 "Direct link to Types"/index.html)

ClientUploadRequest [​](/content/docs/sdks/tigris/api/#clientuploadrequest "Direct link to clientuploadrequest"/index.html)

interface ClientUploadRequest {

action: UploadAction;

name: string;

/** @deprecated This property is no longer used by the server handler. Will be removed in the next major version. */

contentType?: string;

uploadId?: string;

parts?: number[];

partIds?: Array<{

[key: number]: string;

}>;

}

UploadAction [​](/content/docs/sdks/tigris/api/#uploadaction "Direct link to uploadaction"/index.html)

enum UploadAction {

SinglepartInit = "singlepart-init",

MultipartInit = "multipart-init",

MultipartGetParts = "multipart-get-parts",

MultipartComplete = "multipart-complete",

}

Statistics [​](/content/docs/sdks/tigris/api/#statistics "Direct link to Statistics"/index.html)

Retrieve account and bucket-level storage statistics.

getStats [​](/content/docs/sdks/tigris/api/#getstats "Direct link to getstats"/index.html)

function getStats(

options?: GetStatsOptions,

): Promise<TigrisStorageResponse<StatsResponse, Error>>;

Types [​](/content/docs/sdks/tigris/api/#types-8 "Direct link to Types"/index.html)

GetStatsOptions [​](/content/docs/sdks/tigris/api/#getstatsoptions "Direct link to getstatsoptions"/index.html)

type GetStatsOptions = {

paginationToken?: string;

config?: TigrisStorageConfig;

};

StatsResponse [​](/content/docs/sdks/tigris/api/#statsresponse "Direct link to statsresponse"/index.html)

type StatsResponse = {

paginationToken?: string;

stats: BucketsStats;

buckets: Bucket[];

};

BucketType [​](/content/docs/sdks/tigris/api/#buckettype "Direct link to buckettype"/index.html)

type BucketType = "Regular" | "Snapshot";

BucketVisibility [​](/content/docs/sdks/tigris/api/#bucketvisibility "Direct link to bucketvisibility"/index.html)

type BucketVisibility = "public" | "private";

Common Types [​](/content/docs/sdks/tigris/api/#common-types "Direct link to Common Types"/index.html)

Shared configuration and response types used across all API methods.

Types [​](/content/docs/sdks/tigris/api/#types-9 "Direct link to Types"/index.html)

TigrisStorageConfig [​](/content/docs/sdks/tigris/api/#tigrisstorageconfig "Direct link to tigrisstorageconfig"/index.html)

type TigrisStorageConfig = {

bucket?: string;

forcePathStyle?: boolean;

} & TigrisConfig;

TigrisStorageResponse [​](/content/docs/sdks/tigris/api/#tigrisstorageresponse "Direct link to tigrisstorageresponse"/index.html)

type TigrisStorageResponse<T, E = Error> = TigrisResponse<T, E>;

TigrisResponse [​](/content/docs/sdks/tigris/api/#tigrisresponse "Direct link to tigrisresponse"/index.html)

type TigrisResponse<T, E = Error> =

| {

data: T;

error?: never;

}

| {

error: E;

data?: never;

};

StorageClass [​](/content/docs/sdks/tigris/api/#storageclass "Direct link to storageclass"/index.html)

type StorageClass = "STANDARD" | "STANDARD_IA" | "GLACIER" | "GLACIER_IR";

BucketLocations [​](/content/docs/sdks/tigris/api/#bucketlocations "Direct link to bucketlocations"/index.html)

type BucketLocations =

| {

type: "multi";

values: BucketLocationMulti;

}

| {

type: "dual";

values: BucketLocationDualOrSingle | BucketLocationDualOrSingle[];

}

| {

type: "single";

values: BucketLocationDualOrSingle;

}

| {

type: "global";

values?: never;

};

BucketLocationMulti [​](/content/docs/sdks/tigris/api/#bucketlocationmulti "Direct link to bucketlocationmulti"/index.html)

type BucketLocationMulti = (typeof multiRegions)[number];

BucketLocationDualOrSingle [​](/content/docs/sdks/tigris/api/#bucketlocationdualorsingle "Direct link to bucketlocationdualorsingle"/index.html)

type BucketLocationDualOrSingle = (typeof singleOrDualRegions)[number];

multiRegions [​](/content/docs/sdks/tigris/api/#multiregions "Direct link to multiregions"/index.html)

const multiRegions: readonly ["usa", "eur"];

singleOrDualRegions [​](/content/docs/sdks/tigris/api/#singleordualregions "Direct link to singleordualregions"/index.html)

const singleOrDualRegions: readonly [\
\
  "ams",\
\
  "fra",\
\
  "gru",\
\
  "iad",\
\
  "jnb",\
\
  "lhr",\
\
  "nrt",\
\
  "ord",\
\
  "sin",\
\
  "sjc",\
\
  "syd",\
\
];

• Contents
• Client API
  • upload
  • executeWithConcurrency
  • UploadOptions
  • UploadProgress
  • UploadResponse
• Object Operations
  • put
  • get
  • head
  • list
  • remove
  • updateObject
  • PutOptions
  • PutResponse
  • PutOnUploadProgress
  • GetOptions
  • GetResponse
  • HeadOptions
  • HeadResponse
  • ListOptions
  • ListItem
  • ListResponse
  • RemoveOptions
  • UpdateObjectOptions
  • UpdateObjectResponse
• Presigned URLs
  • getPresignedUrl
  • GetPresignedUrlOptions
  • GetPresignedUrlResponse
  • GetPresignedUrlOperation
  • MethodOrOperation
• Bucket Management
  • createBucket
  • getBucketInfo
  • listBuckets
  • updateBucket
  • removeBucket
  • CreateBucketOptions
  • CreateBucketResponse
  • GetBucketInfoOptions
  • BucketInfoResponse
  • ListBucketsOptions
  • ListBucketsResponse
  • Bucket
  • BucketOwner
  • UpdateBucketOptions
  • UpdateBucketResponse
  • RemoveBucketOptions
• Bucket Configuration
  • setBucketCors
  • setBucketLifecycle
  • setBucketTtl
  • setBucketMigration
  • setBucketNotifications
  • SetBucketCorsOptions
  • SetBucketLifecycleOptions
  • SetBucketTtlOptions
  • SetBucketMigrationOptions
  • SetBucketNotificationsOptions
  • BucketCorsRule
  • BucketLifecycleRule
  • BucketTtl
  • BucketMigration
  • BucketNotification
  • BucketNotificationBase
  • BucketNotificationBasicAuth
  • BucketNotificationTokenAuth
• Snapshots
  • createBucketSnapshot
  • listBucketSnapshots
  • CreateBucketSnapshotOptions
  • CreateBucketSnapshotResponse
  • ListBucketSnapshotsOptions
  • ListBucketSnapshotsResponse
• Multipart Upload
  • initMultipartUpload
  • getPartsPresignedUrls
  • completeMultipartUpload
  • InitMultipartUploadOptions
  • InitMultipartUploadResponse
  • GetPartsPresignedUrlsOptions
  • GetPartsPresignedUrlsResponse
  • CompleteMultipartUploadOptions
  • CompleteMultipartUploadResponse
• Client Upload Handling
  • handleClientUpload
  • ClientUploadRequest
  • UploadAction
• Statistics
  • getStats
  • GetStatsOptions
  • StatsResponse
  • BucketType
  • BucketVisibility
• Common Types
  • TigrisStorageConfig
  • TigrisStorageResponse
  • TigrisResponse
  • StorageClass
  • BucketLocations
  • BucketLocationMulti
  • BucketLocationDualOrSingle
  • multiRegions
  • singleOrDualRegions