docs/source/developers/javascript/API.md

JavaScript Client API Reference

Initialize MinIO Client object.

MinIO

var Minio = require('minio')

var minioClient = new Minio.Client({
    endPoint: 'play.min.io',
    port: 9000,
    useSSL: true,
    accessKey: 'Q3AM3UQ867SPQQA43P2F',
    secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
});

AWS S3

var Minio = require('minio')

var s3Client = new Minio.Client({
    endPoint:  's3.amazonaws.com',
    accessKey: 'YOUR-ACCESSKEYID',
    secretKey: 'YOUR-SECRETACCESSKEY'
})

Bucket operations	Object operations	Presigned operations	Bucket Policy & Notification operations	Custom Settings
makeBucket	getObject	presignedUrl	getBucketNotification	setS3TransferAccelerate
listBuckets	getPartialObject	presignedGetObject	setBucketNotification
bucketExists	fGetObject	presignedPutObject	removeAllBucketNotification
removeBucket	putObject	presignedPostPolicy	getBucketPolicy
listObjects	fPutObject		setBucketPolicy
listObjectsV2	copyObject		listenBucketNotification
listIncompleteUploads	statObject
getBucketVersioning	removeObject
setBucketVersioning	removeObjects
getBucketTagging	removeIncompleteUpload
setBucketTagging	putObjectRetention
removeBucketTagging	getObjectRetention
setBucketLifecycle	putObjectTagging
getBucketLifecycle	removeObjectTagging
removeBucketLifecycle	getObjectTagging
setObjectLockConfig	getObjectLegalHold
getObjectLockConfig	setObjectLegalHold
getBucketEncryption	composeObject
setBucketEncryption	selectObjectContent
removeBucketEncryption
setBucketReplication
getBucketReplication
removeBucketReplication

1. Constructor

new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})

new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})
Initializes a new client object.

Parameters

Param	Type	Description
endPoint	string	endPoint is a host name or an IP address.
port	number	TCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs.
useSSL	bool	If set to true, https is used instead of http. Default is true.
accessKey	string	accessKey is like user-id that uniquely identifies your account.
secretKey	string	secretKey is the password to your account.
sessionToken	string	Set this value to provide x-amz-security-token (AWS S3 specific). (Optional)
region	string	Set this value to override region cache. (Optional)
transport	string	Set this value to pass in a custom transport. (Optional)
partSize	number	Set this value to override default part size of 64MB for multipart uploads. (Optional)
pathStyle	bool	Set this value to override default access behavior (path) for non AWS endpoints. Default is true. (Optional)

Example

Create client for MinIO

var Minio = require('minio')

var minioClient = new Minio.Client({
    endPoint: 'play.min.io',
    port: 9000,
    useSSL: true,
    accessKey: 'Q3AM3UQ867SPQQA43P2F',
    secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG'
});

Create client for AWS S3

var Minio = require('minio')

var s3Client = new Minio.Client({
    endPoint:  's3.amazonaws.com',
    accessKey: 'YOUR-ACCESSKEYID',
    secretKey: 'YOUR-SECRETACCESSKEY'
})

Create client with temporary credentials

var Minio = require('minio')

var s3Client = new Minio.Client({
    endPoint:  's3.amazonaws.com',
    accessKey: 'YOUR-TEMP-ACCESSKEYID',
    secretKey: 'YOUR-TEMP-SECRETACCESSKEY',
    sessionToken: 'YOUR-TEMP-SESSIONTOKEN'
})

2. Bucket operations

makeBucket(bucketName, region[, makeOpts , callback])

Creates a new bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
region	string	Region where the bucket is created. This parameter is optional. Default value is us-east-1.
makeOpts	object	Options to create a bucket. e.g {ObjectLocking:true} (Optional)
callback(err)	function	Callback function with err as the error argument. err is null if the bucket is successfully created. If no callback is passed, a Promise is returned.

Example

minioClient.makeBucket('mybucket', 'us-east-1', function(err) {
  if (err) return console.log('Error creating bucket.', err)
  console.log('Bucket created successfully in "us-east-1".')
})

Example 1 Create a bucket with object locking enabled.

minioClient.makeBucket('mybucket', 'us-east-1', { ObjectLocking:true }, function(err) {
  if (err) return console.log('Error creating bucket with object lock.', err)
  console.log('Bucket created successfully in "us-east-1" and enabled object lock')
})

listBuckets([callback])

Lists all buckets.

Parameters

Param	Type	Description
callback(err, bucketStream)	function	Callback function with error as the first argument. bucketStream is the stream emitting bucket information. If no callback is passed, a Promise is returned.

bucketStream emits Object with the format:-

Param	Type	Description
bucket.name	string	bucket name
bucket.creationDate	Date	date when bucket was created.

Example

minioClient.listBuckets(function(err, buckets) {
  if (err) return console.log(err)
  console.log('buckets :', buckets)
})

bucketExists(bucketName[, callback])

Checks if a bucket exists.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, exists)	function	exists is a boolean which indicates whether bucketName exists or not. err is set when an error occurs during the operation. If no callback is passed, a Promise is returned.

Example

minioClient.bucketExists('mybucket', function(err, exists) {
  if (err) {
    return console.log(err)
  }
  if (exists) {
    return console.log('Bucket exists.')
  }
})

removeBucket(bucketName[, callback])

Removes a bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err)	function	err is null if the bucket is removed successfully. If no callback is passed, a Promise is returned.

Example

minioClient.removeBucket('mybucket', function(err) {
  if (err) return console.log('unable to remove bucket.')
  console.log('Bucket removed successfully.')
})

listObjects(bucketName, prefix, recursive [,listOpts])

Lists all objects in a bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
prefix	string	The prefix of the objects that should be listed (optional, default '').
recursive	bool	true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
listOpts	object	query params to list object which can have {IncludeVersion: _bool_ } (optional)

Return Value

Param	Type	Description
stream	Stream	Stream emitting the objects in the bucket.

The object is of the format:

Param	Type	Description
obj.name	string	name of the object.
obj.prefix	string	name of the object prefix.
obj.size	number	size of the object.
obj.etag	string	etag of the object.
obj.versionId	string	versionId of the object.
obj.isDeleteMarker	boolean	true if it is a delete marker.
obj.lastModified	Date	modified time stamp.

Example

var data = []
var stream = minioClient.listObjects('mybucket','', true)
stream.on('data', function(obj) { data.push(obj) } )
stream.on("end", function (obj) { console.log(data) })
stream.on('error', function(err) { console.log(err) } )

Example1 To get Object versions

var data = []
var stream = minioClient.listObjects('mybucket','', true, {IncludeVersion:true})
stream.on('data', function(obj) { data.push(obj) } )
stream.on("end", function (obj) { console.log(data) })
stream.on('error', function(err) { console.log(err) } )

listObjectsV2(bucketName, prefix, recursive, startAfter)

Lists all objects in a bucket using S3 listing objects V2 API

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
prefix	string	The prefix of the objects that should be listed (optional, default '').
recursive	bool	true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
startAfter	string	Specifies the object name to start after when listing objects in a bucket. (optional, default '').

Return Value

Param	Type	Description
stream	Stream	Stream emitting the objects in the bucket.

The object is of the format:

Param	Type	Description
obj.name	string	name of the object.
obj.prefix	string	name of the object prefix.
obj.size	number	size of the object.
obj.etag	string	etag of the object.
obj.lastModified	Date	modified time stamp.

Example

var stream = minioClient.listObjectsV2('mybucket','', true,'')
stream.on('data', function(obj) { console.log(obj) } )
stream.on('error', function(err) { console.log(err) } )

listObjectsV2WithMetadata(bucketName, prefix, recursive, startAfter)

Lists all objects and their metadata in a bucket using S3 listing objects V2 API

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
prefix	string	The prefix of the objects that should be listed (optional, default '').
recursive	bool	true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
startAfter	string	Specifies the object name to start after when listing objects in a bucket. (optional, default '').

Return Value

Param	Type	Description
stream	Stream	Stream emitting the objects in the bucket.

The object is of the format:

Param	Type	Description
obj.name	string	name of the object.
obj.prefix	string	name of the object prefix.
obj.size	number	size of the object.
obj.etag	string	etag of the object.
obj.lastModified	Date	modified time stamp.
obj.metadata	object	metadata of the object.

Example

var stream = minioClient.extensions.listObjectsV2WithMetadata('mybucket','', true,'')
stream.on('data', function(obj) { console.log(obj) } )
stream.on('error', function(err) { console.log(err) } )

listIncompleteUploads(bucketName, prefix, recursive)

Lists partially uploaded objects in a bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
prefix	string	Prefix of the object names that are partially uploaded. (optional, default '')
recursive	bool	true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).

Return Value

Param	Type	Description
stream	Stream	Emits objects of the format listed below:

Param	Type	Description
part.key	string	name of the object.
part.uploadId	string	upload ID of the object.
part.size	Integer	size of the partially uploaded object.

Example

var Stream = minioClient.listIncompleteUploads('mybucket', '', true)
Stream.on('data', function(obj) {
  console.log(obj)
})
Stream.on('end', function() {
  console.log('End')
})
Stream.on('error', function(err) {
  console.log(err)
})

getBucketVersioning(bucketName)

Get Versioning state of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, res)	function	Callback is called with err in case of error. res is the response object. If no callback is passed, a Promise is returned.

Example

minioClient.getBucketVersioning('bucketname', function (err,res){
  if (err) {
    return console.log(err)
  }
  console.log(res)
  console.log("Success")
})

setBucketVersioning(bucketName, versioningConfig, callback)

Set Versioning state on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
versioningConfig	object	Versioning Configuration e.g: {Status:"Enabled"}
callback(err)	function	Callback is called with err in case of error.

Example

var versioningConfig = {Status:"Enabled"}
minioClient.setBucketVersioning('bucketname',versioningConfig, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

setBucketReplication(bucketName, replicationConfig, callback)

Set replication config on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
replicationConfig	object	replicationConfig Configuration as a JSON Object
callback(err)	function	Callback is called with err in case of error.

Example

const arnFromMcCli = "arn:minio:replication::1277fcbe7df0bab76ab0c64cf7c45a0d27e01917ee5f11e913f3478417833660:destination"

var replicationConfig = {
    role:arnFromMcCli,
    rules:[{
        "DeleteMarkerReplication": {
            "Status": "Disabled"
        },
        "DeleteReplication": {
            "Status": [
            ]
        },
        "Destination": {
            "Bucket": "arn:aws:s3:::destination"
        },
        "Priority": "1",
        "Status": "Enabled"
    }]
}

minioClient.setBucketReplication('bucketname',replicationConfig, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

getBucketReplication(bucketName, callback)

Get replication config of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, replicationConfig)	function	Callback is called with err in case of error. else returns the info inreplicationConfig ,which contains{role: __string__, rules:__Array__ }.

Example

minioClient.getBucketReplication('bucketname', function (err,replicationConfig){
  if (err) {
    return console.log(err)
  }
  console.log(replicationConfig)
})

removeBucketReplication(bucketName, callback)

Remove replication config of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.removeBucketReplication('bucketname', function (err,replicationConfig){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

setBucketTagging(bucketName, tags, callback)

Set Tags on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
tags	object	Tags map Configuration e.g: {<tag-key-1>:<tag-value-1>}
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.setBucketTagging('bucketname',tags, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

removeBucketTagging(bucketName, callback)

Remove Tags on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.removeBucketTagging('bucketname', function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

getBucketTagging(bucketName, callback)

Remove Tags on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, tagsList)	function	Callback is called with err in case of error.

Example

minioClient.getBucketTagging('bucketname', function (err, tagsList){
  if (err) {
    return console.log(err)
  }
  console.log("Success",tagsList)
})

setBucketLifecycle(bucketName, lifecycleConfig, callback)

Set Lifecycle Configuration on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
lifecycleConfig	object	Valid Lifecycle Configuration or ( null or '' ) to remove policy configuration
callback(err)	function	Callback is called with err in case of error.

Example

const lifecycleConfig= {
    Rule: [{
        "ID": "Transition and Expiration Rule",
        "Status": "Enabled",
        "Filter": {
            "Prefix":"",
        },
        "Expiration": {
            "Days": "3650"
        } 
    }
   ]
}
    
minioClient.setBucketLifecycle('bucketname',lifecycleConfig, function (err) {
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

getBucketLifecycle(bucketName, callback)

Get Lifecycle Configuration of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(error, lifecycleConfig)	function	Callback is called with lifecycleConfig in case of success. Otherwise it is called with error

Example

minioClient.getBucketLifecycle('bucketname', function (err, lifecycleConfig) {
  if (err) {
      return console.log(err)
  }
  console.log("Success", lifecycleConfig)
})

removeBucketLifecycle(bucketName, callback)

Remove Lifecycle Configuration of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err)	function	Callback is called with err in case of error.

Example

 
minioClient.removeBucketLifecycle('bucketname', function (err) {
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

setObjectLockConfig(bucketName, lockConfig [, callback])

Set Object lock config on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
lockConfig	object	Lock Configuration can be either {} to reset or object with all of the following key/value pairs: {mode: ["COMPLIANCE"/'GOVERNANCE'], unit: ["Days"/"Years"], validity: <a-valid-number-for-unit>}
callback(err)	function	Callback is called with err in case of error.

Example 1

s3Client.setObjectLockConfig('my-bucketname', {mode:"COMPLIANCE", unit:'Days', validity:10 }, function (err){
    if (err) {
        return console.log(err)
    }
    console.log("Success")
})

Example 2 To reset/remove object lock config on a bucket.

s3Client.setObjectLockConfig('my-bucketname', {}, function (err){
if (err) {
return console.log(err)
}
console.log("Success")
})

getObjectLockConfig(bucketName [, callback])

Get Lock config on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, lockConfig)	function	Callback is called with err in case of error. else it is called with lock configuration

__Example __ Get object lock configuration on a Bucket

s3Client.getObjectLockConfig('my-bucketname', function (err, lockConfig){
    if (err) {
        return console.log(err)
    }
    console.log(lockConfig)
})

setBucketEncryption(bucketName [,encryptionConfig, callback])

Set encryption configuration on a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
encryptionConfig	object	Encryption Configuration can be either omitted or {} or a valid and supported encryption config. by default: {Rule:[{ApplyServerSideEncryptionByDefault:{SSEAlgorithm:"AES256"}}]} is applied.
callback(err)	function	Callback is called with err in case of error.

__Example __ Set Encryption configuration on a Bucket

s3Client.setBucketEncryption('my-bucketname', function (err, lockConfig){
    if (err) {
        return console.log(err)
    }
    console.log(lockConfig)
})

Example 1 Set Encryption configuration on a Bucket with an Algorithm

s3Client.setBucketEncryption('my-bucketname',{Rule:[{ApplyServerSideEncryptionByDefault:{SSEAlgorithm:"AES256"}}]}, function (err, lockConfig){
    if (err) {
        return console.log(err)
    }
    console.log("Success")
})

getBucketEncryption(bucketName [, callback])

Get encryption configuration of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, encConfig)	function	Callback is called with err in case of error. else it is called with lock configuration

__Example __ Get Encryption configuration of a Bucket

s3Client.getBucketEncryption('my-bucketname', function (err, encConfig){
    if (err) {
        return console.log(err)
    }
    console.log(encConfig)
})

removeBucketEncryption(bucketName [, callback])

Remove encryption configuration of a Bucket

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err)	function	Callback is called with err in case of error.

__Example __ Remove Encryption configuration of a Bucket

s3Client.removeBucketEncryption('my-bucketname', function (err){
    if (err) {
        return console.log(err)
    }
    console.log("Success")
})

3. Object operations

getObject(bucketName, objectName, getOpts[, callback])

Downloads an object as a stream.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
getOpts	object	Version of the object in the form {versionId:"my-versionId"}. Default is {}. (optional)
callback(err, stream)	function	Callback is called with err in case of error. stream is the object content stream. If no callback is passed, a Promise is returned.

Return Value

Param	Type	Description
stream	Stream	Stream emitting the object content.

Example

var size = 0
minioClient.getObject('mybucket', 'photo.jpg', function(err, dataStream) {
  if (err) {
    return console.log(err)
  }
  dataStream.on('data', function(chunk) {
    size += chunk.length
  })
  dataStream.on('end', function() {
    console.log('End. Total size = ' + size)
  })
  dataStream.on('error', function(err) {
    console.log(err)
  })
})

Example

Get a specific object version.

var size = 0
minioClient.getObject('mybucket', 'photo.jpg', {versionId:"my-versionId"}, function(err, dataStream) {
  if (err) {
    return console.log(err)
  }
  dataStream.on('data', function(chunk) {
    size += chunk.length
  })
  dataStream.on('end', function() {
    console.log('End. Total size = ' + size)
  })
  dataStream.on('error', function(err) {
    console.log(err)
  })
})

getPartialObject(bucketName, objectName, offset, length, getOpts[, callback])

Downloads the specified range bytes of an object as a stream.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
offset	number	offset of the object from where the stream will start.
length	number	length of the object that will be read in the stream (optional, if not specified we read the rest of the file from the offset).
getOpts	object	Version of the object in the form {versionId:'my-versionId'}. Default is {}. (optional)
callback(err, stream)	function	Callback is called with err in case of error. stream is the object content stream. If no callback is passed, a Promise is returned.

Return Value

Param	Type	Description
stream	Stream	Stream emitting the object content.

Example

var size = 0
// reads 30 bytes from the offset 10.
minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, function(err, dataStream) {
  if (err) {
    return console.log(err)
  }
  dataStream.on('data', function(chunk) {
    size += chunk.length
  })
  dataStream.on('end', function() {
    console.log('End. Total size = ' + size)
  })
  dataStream.on('error', function(err) {
    console.log(err)
  })
})

Example To get a specific version of an object

var versionedObjSize = 0
// reads 30 bytes from the offset 10.
minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, {versionId:"my-versionId"}, function(err, dataStream) {
  if (err) {
    return console.log(err)
  }
  dataStream.on('data', function(chunk) {
      versionedObjSize += chunk.length
  })
  dataStream.on('end', function() {
    console.log('End. Total size = ' + versionedObjSize)
  })
  dataStream.on('error', function(err) {
    console.log(err)
  })
})

fGetObject(bucketName, objectName, filePath, getOpts[, callback])

Downloads and saves the object as a file in the local filesystem.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
filePath	string	Path on the local filesystem to which the object data will be written.
getOpts	object	Version of the object in the form {versionId:'my-versionId'}. Default is {}. (optional)
callback(err)	function	Callback is called with err in case of error. If no callback is passed, a Promise is returned.

Return Value

Value	Type	Description
err	object	Error in case of any failures
file	file	Streamed Output file at the specified filePath

Example

var size = 0
minioClient.fGetObject('mybucket', 'photo.jpg', '/tmp/photo.jpg', function(err) {
  if (err) {
    return console.log(err)
  }
  console.log('success')
})

Example To Stream a specific object version into a file.

minioClient.fGetObject(bucketName, objNameValue, './download/MyImage.jpg', {versionId:"my-versionId"}, function(e) {
  if (e) {
    return console.log(e)
  }
  console.log('success')
})

putObject(bucketName, objectName, stream, size, metaData[, callback])

Uploads an object from a stream/Buffer.

From a stream

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
stream	Stream	Readable stream.
size	number	Size of the object (optional).
metaData	Javascript Object	metaData of the object (optional).
callback(err, objInfo)	function	Non-null err indicates error, in case of Success,objInfo contains etag string and versionId string of the object. If no callback is passed, a Promise is returned.

Return Value

Value	Type	Description
err	object	Error in case of any failures
objInfo.etag	string	etag of an object
objInfo.versionId	string	versionId of an object (optional)

Example

The maximum size of a single object is limited to 5TB. putObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.

var Fs = require('fs')
var file = '/tmp/40mbfile'
var fileStream = Fs.createReadStream(file)
var fileStat = Fs.stat(file, function(err, stats) {
  if (err) {
    return console.log(err)
  }
  minioClient.putObject('mybucket', '40mbfile', fileStream, stats.size, function(err, objInfo) {
      if(err) {
          return console.log(err) // err should be null
      }
   console.log("Success", objInfo)
  })
})

From a "Buffer" or a "string"

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
string or Buffer	Stream or Buffer	Readable stream.
metaData	Javascript Object	metaData of the object (optional).
callback(err, etag)	function	Non-null err indicates error, etag string is the etag of the object uploaded.

Example

var buffer = 'Hello World'
minioClient.putObject('mybucket', 'hello-file', buffer, function(err, etag) {
  return console.log(err, etag) // err should be null
})

fPutObject(bucketName, objectName, filePath, metaData[, callback])

Uploads contents from a file to objectName.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
filePath	string	Path of the file to be uploaded.
metaData	Javascript Object	Metadata of the object.
callback(err, objInfo) function: non null err indicates error, objInfo object is the information about the object uploaded which contains versionId string and etag string.

Return Value

Value	Type	Description
err	object	Error in case of any failures
objInfo.etag	string	etag of an object
objInfo.versionId	string	versionId of an object (optional)

Example

The maximum size of a single object is limited to 5TB. fPutObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.

var file = '/tmp/40mbfile'
var metaData = {
  'Content-Type': 'text/html',
  'Content-Language': 123,
  'X-Amz-Meta-Testing': 1234,
  'example': 5678
}
minioClient.fPutObject('mybucket', '40mbfile', file, metaData, function(err, objInfo) {
    if(err) {
        return console.log(err)
    }
    console.log("Success", objInfo.etag, objInfo.versionId)
})

copyObject(bucketName, objectName, sourceObject, conditions[, callback])

Copy a source object into a new object in the specified bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
sourceObject	string	Path of the file to be copied.
conditions	CopyConditions	Conditions to be satisfied before allowing object copy.
callback(err, {etag, lastModified})	function	Non-null err indicates error, etag string and lastModified Date are the etag and the last modified date of the object newly copied. If no callback is passed, a Promise is returned.

Example

var conds = new Minio.CopyConditions()
conds.setMatchETag('bd891862ea3e22c93ed53a098218791d')
minioClient.copyObject('mybucket', 'newobject', '/mybucket/srcobject', conds, function(e, data) {
  if (e) {
    return console.log(e)
  }
  console.log("Successfully copied the object:")
  console.log("etag = " + data.etag + ", lastModified = " + data.lastModified)
})

statObject(bucketName, objectName, statOpts[, callback])

Gets metadata of an object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
statOpts	object	Version of the object in the form {versionId:"my-versionId"}. Default is {}. (optional)
callback(err, stat)	function	err is not null in case of error, stat contains the object information listed below. If no callback is passed, a Promise is returned.

Return Value

Param	Type	Description
stat.size	number	size of the object.
stat.etag	string	etag of the object.
stat.versionId	string	version of the object.
stat.metaData	Javascript Object	metadata of the object.
stat.lastModified	Date	Last Modified time stamp.

Example

minioClient.statObject('mybucket', 'photo.jpg', function(err, stat) {
  if (err) {
    return console.log(err)
  }
  console.log(stat)
})

Example stat on a version of an object

minioClient.statObject('mybucket', 'photo.jpg', { versionId : "my-versionId" }, function(err, stat) {
  if (err) {
    return console.log(err)
  }
  console.log(stat)
})

removeObject(bucketName, objectName [, removeOpts] [, callback])

Removes an object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
removeOpts	object	Version of the object in the form {versionId:"my-versionId", governanceBypass: true or false }. Default is {}. (Optional)
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example 1

minioClient.removeObject('mybucket', 'photo.jpg', function(err) {
  if (err) {
    return console.log('Unable to remove object', err)
  }
  console.log('Removed the object')
})

Example 2 Delete a specific version of an object

minioClient.removeObject('mybucket', 'photo.jpg', { versionId : "my-versionId" }, function(err) {
  if (err) {
    return console.log('Unable to remove object', err)
  }
  console.log('Removed the object')
})

Example 3 Remove an object version locked with retention mode GOVERNANCE using the governanceBypass remove option

s3Client.removeObject('my-bucketname', 'my-objectname', {versionId:"my-versionId", governanceBypass:true}, function(e) {
  if (e) {
    return console.log(e)
  }
  console.log("Success")
})

removeObjects(bucketName, objectsList[, callback])

Remove all objects in the objectsList.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectsList	object	list of objects in the bucket to be removed. any one of the formats: 1. List of Object names as array of strings which are object keys: ['objectname1','objectname2'] 2. List of Object name and VersionId as an object: [{name:"my-obj-name",versionId:"my-versionId"}]
callback(err)	function	Callback function is called with non null value in case of error.

Example

var objectsList = []

// List all object paths in bucket my-bucketname.
var objectsStream = s3Client.listObjects('my-bucketname', 'my-prefixname', true)

objectsStream.on('data', function(obj) {
  objectsList.push(obj.name);
})

objectsStream.on('error', function(e) {
  console.log(e);
})

objectsStream.on('end', function() {

  s3Client.removeObjects('my-bucketname',objectsList, function(e) {
    if (e) {
        return console.log('Unable to remove Objects ',e)
    }
    console.log('Removed the objects successfully')
  })

})

Example1

With versioning Support

var objectsList=[]
var bucket ="my-bucket"
var prefix="my-prefix"
var recursive=false

var objectsStream = s3Client.listObjects(bucket, prefix, recursive, {IncludeVersion: true})
  objectsStream.on('data', function (obj) {
      objectsList.push(obj)
  })
  objectsStream.on('error', function (e) {
    return console.log(e)
  })
  objectsStream.on('end', function () {
    s3Client.removeObjects(bucket, objectsList, function (e) {
      if (e) {
        return console.log(e)
      }
      console.log("Success")
    })
  })

removeIncompleteUpload(bucketName, objectName[, callback])

Removes a partially uploaded object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example

minioClient.removeIncompleteUpload('mybucket', 'photo.jpg', function(err) {
  if (err) {
    return console.log('Unable to remove incomplete object', err)
  }
  console.log('Incomplete object removed successfully.')
})

putObjectRetention(bucketName, objectName [, retentionOpts] [, callback])

Apply retention on an object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
retentionOpts	object	Options for retention like : { governanceBypass:true/false ,mode:COMPLIANCE/GOVERNANCE, retainUntilDate: _date_ , versionId:"my-versionId" } Default is {} (Optional)
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example Apply object retention on an object

const bucketName = 'my-bucket'
const objectName ="my-object"

const expirationDate = new Date()
expirationDate.setDate(expirationDate.getDate() + 1)
expirationDate.setUTCHours(0,0,0,0)//Should be start of the day.(midnight)
const versionId ="e67b4b08-144d-4fc4-ba15-43c3f7f9ba74"

const objRetPromise = minioClient.putObjectRetention(
    bucketName, 
    objectName, 
    { Mode:"GOVERNANCE", retainUntilDate:retainUntilDate.toISOString(), versionId:versionId }, 
    function (err){
    if (err) {
        return console.log(err)
    }
    console.log("Success")
})

getObjectRetention(bucketName, objectName [, getOpts] [, callback])

Get retention config of an object

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
getOpts	object	Options for retention like : { versionId:"my-versionId" } Default is {} (Optional)
callback(err, res)	function	Callback is called with err in case of error. res is the response object. If no callback is passed, a Promise is returned.

Example

minioClient.getObjectRetention('bucketname', 'bucketname', { versionId: "my-versionId" }, function (err, res){
  if (err) {
    return console.log(err)
  }
  console.log(res)
})

putObjectTagging(bucketName, objectName, tags[, putOpts, callback])

setObjectTagging(bucketName, objectName, tags[, putOpts, callback])

Put Tags on an Object

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
tags	object	Tags map Configuration e.g: {<tag-key-1>:<tag-value-1>}
putOpts	object	Default is {}. e.g {versionId:"my-version-id"}. (Optional)
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.setObjectTagging('bucketname','object-name', tags, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

Example 1 Put tags on a version of an object.

minioClient.setObjectTagging('bucketname','object-name', tags, { versionId: "my-version-id" }, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

removeObjectTagging(bucketName, objectName[, removeOpts, callback])

Remove Tags on an Object

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
removeOpts	object	Defaults to {}. e.g {versionId:"my-version-id"}. (Optional)
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.removeObjectTagging('bucketname','object-name', function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

Example1 Remove tags on a version of an object.

minioClient.removeObjectTagging('bucketname', 'object-name', {versionId:"my-object-version-id"}, function (err){
  if (err) {
    return console.log(err)
  }
  console.log("Success")
})

getObjectTagging(bucketName, objectName[, getOpts, callback])

Get Tags of an Object

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
getOpts	object	Defaults to {}. e.g {versionId:"my-version-id"}. (Optional)
callback(err)	function	Callback is called with err in case of error.

Example

minioClient.getObjectTagging('bucketname', 'object-name', function (err, tagsList){
  if (err) {
    return console.log(err)
  }
  console.log("Success", tagsList)
})

Example1 Get tags on a version of an object.

minioClient.getObjectTagging('bucketname', 'object-name', {versionId:"my-object-version-id"}, function (err, tagsList){
  if (err) {
    return console.log(err)
  }
  console.log("Success", tagsList)
})

getObjectLegalHold(bucketName, objectName, getOpts [, callback])

Get legal hold on an object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
getOpts	object	Legal hold configuration options. e.g {versionId:'my-version-uuid'} defaults to {} .
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example 1

Get Legal hold of an object.

minioClient.getObjectLegalHold('bucketName', 'objectName', {}, function(err, res) {
  if (err) {
    return console.log('Unable to get legal hold config for the object', err.message)
  }
  console.log('Success', res)
})

Example 2

Get Legal hold of an object with versionId.

minioClient.getObjectLegalHold('bucketName', 'objectName', { versionId:'my-obj-version-uuid' }, function(err, res) {
  if (err) {
    return console.log('Unable to get legal hold config for the object', err.message)
  }
  console.log('Success', res)
})

setObjectLegalHold(bucketName, objectName, [,setOpts, callback])

Set legal hold on an object.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
setOpts	object	Legal hold configuration options to set. e.g {versionId:'my-version-uuid', status:'ON or OFF'} defaults to {status:'ON'} if not passed.
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example 1

Set Legal hold of an object.

minioClient.setObjectLegalHold('bucketName', 'objectName', {Status:"ON"}, function(err, res) {
  if (err) {
    return console.log('Unable to set legal hold config for the object', err.message)
  }
  console.log('Success')
})

Example 2

Set Legal hold of an object with versionId.

minioClient.setObjectLegalHold('bucketName', 'objectName', { Status:"ON", versionId:'my-obj-version-uuid' }, function(err, res) {
  if (err) {
    return console.log('Unable to set legal hold config for the object version', err.message)
  }
  console.log('Success')
})

composeObject(destObjConfig, sourceObjectList [, callback])

Compose an object from parts

Parameters

Param	Type	Description
destObjConfig	object	Destination Object configuration of the type CopyDestinationOptions
sourceObjectList	object[]	Array of object(parts) source to compose into an object. Each part configuration should be of type CopySourceOptions
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned.

Example 1

Compose an Object from its parts .

const sourceList = [new Helpers.CopySourceOptions( {
    Bucket:     "source-bucket",
    Object:     "parta",
}),new Helpers.CopySourceOptions({
    Bucket:     "source-bucket",
    Object:     "partb",
}),new Helpers.CopySourceOptions({
    Bucket:     "source-bucket",
    Object:     "partc",

}),new Helpers.CopySourceOptions({
    Bucket:     "source-bucket",
    Object:     "partd",
})]

const destOption = new Helpers.CopyDestinationOptions({
    Bucket:     "dest-bucket",
    Object:     "100MB.zip"
})

//using Promise style.
const composePromise = minioClient.composeObject(destOption,sourceList)
    composePromise.then((result) => {
        console.log("Success...")
    })
    .catch((e)=>{
        console.log("error",e)
    })

selectObjectContent(bucketName, objectName, selectOpts[, callback])

Select contents of an object (S3 Select).

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
selectOpts	object
callback(err)	function	Callback function is called with non null value in case of error. If no callback is passed, a Promise is returned, with the SelectResults type

Example 1 Select all values

const selectOpts = {
    expression:"SELECT * FROM s3object s where s.\"Name\" = 'Jane'",
    expressionType:"SQL",
    inputSerialization : {'CSV': {"FileHeaderInfo": "Use",
            RecordDelimiter: "\n",
            FieldDelimiter:  ",",
        },
        'CompressionType': 'NONE'},
    outputSerialization : {'CSV': {RecordDelimiter: "\n",
            FieldDelimiter:  ",",}},
    requestProgress:{Enabled:true},
}

minioClient.selectObjectContent('bucketName', 'objectName', selectOpts, function(err, res) {
  if (err) {
    return console.log('Unable to process select object content.', err.message)
  }
  console.log('Success')
})

4. Presigned operations

Presigned URLs are generated for temporary download/upload access to private objects.

presignedUrl(httpMethod, bucketName, objectName[, expiry, reqParams, requestDate, cb])

Generates a presigned URL for the provided HTTP method, 'httpMethod'. Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
expiry	number	Expiry time in seconds. Default value is 7 days. (optional)
reqParams	object	request parameters. (optional) e.g {versionId:"10fa9946-3f64-4137-a58f-888065c0732e"}
requestDate	Date	A date object, the url will be issued at. Default value is now. (optional)
callback(err, presignedUrl)	function	Callback function is called with non null err value in case of error. presignedUrl will be the URL using which the object can be downloaded using GET request. If no callback is passed, a Promise is returned.

Example1

// presigned url for 'getObject' method.
// expires in a day.
minioClient.presignedUrl('GET', 'mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
  if (err) return console.log(err)
  console.log(presignedUrl)
})

Example2

// presigned url for 'listObject' method.
// Lists objects in 'myBucket' with prefix 'data'.
// Lists max 1000 of them.
minioClient.presignedUrl('GET', 'mybucket', '', 1000, {'prefix': 'data', 'max-keys': 1000}, function(err, presignedUrl) {
  if (err) return console.log(err)
  console.log(presignedUrl)
})

Example 3

// Get Object with versionid
minioClient.presignedUrl('GET', 'mybucket', '', 1000, {versionId: "10fa9946-3f64-4137-a58f-888065c0732e"}, function(err, presignedUrl) {
  if (err) return console.log(err)
  console.log(presignedUrl)
})

presignedGetObject(bucketName, objectName[, expiry, respHeaders, requestDate, cb])

Generates a presigned URL for HTTP GET operations. Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
expiry	number	Expiry time in seconds. Default value is 7 days. (optional)
respHeaders	object	response headers to override (optional)
requestDate	Date	A date object, the url will be issued at. Default value is now. (optional)
callback(err, presignedUrl)	function	Callback function is called with non null err value in case of error. presignedUrl will be the URL using which the object can be downloaded using GET request. If no callback is passed, a Promise is returned.

Example

// expires in a day.
minioClient.presignedGetObject('mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
  if (err) return console.log(err)
  console.log(presignedUrl)
})

presignedPutObject(bucketName, objectName, expiry[, callback])

Generates a presigned URL for HTTP PUT operations. Browsers/Mobile clients may point to this URL to upload objects directly to a bucket even if it is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
objectName	string	Name of the object.
expiry	number	Expiry time in seconds. Default value is 7 days.
callback(err, presignedUrl)	function	Callback function is called with non null err value in case of error. presignedUrl will be the URL using which the object can be uploaded using PUT request. If no callback is passed, a Promise is returned.

Example

// expires in a day.
minioClient.presignedPutObject('mybucket', 'hello.txt', 24*60*60, function(err, presignedUrl) {
  if (err) return console.log(err)
  console.log(presignedUrl)
})

presignedPostPolicy(policy[, callback])

Allows setting policy conditions to a presigned URL for POST operations. Policies such as bucket name to receive object uploads, key name prefixes, expiry policy may be set.

Parameters

Param	Type	Description
policy	object	Policy object created by minioClient.newPostPolicy()
callback(err, {postURL, formData})	function	Callback function is called with non null err value in case of error. postURL will be the URL using which the object can be uploaded using POST request. formData is the object having key/value pairs for the Form data of POST body. If no callback is passed, a Promise is returned.

Create policy:

var policy = minioClient.newPostPolicy()

Apply upload policy restrictions:

// Policy restricted only for bucket 'mybucket'.
policy.setBucket('mybucket')

// Policy restricted only for hello.txt object.
policy.setKey('hello.txt')

or

// Policy restricted for incoming objects with keyPrefix.
policy.setKeyStartsWith('keyPrefix')

var expires = new Date
expires.setSeconds(24 * 60 * 60 * 10)
// Policy expires in 10 days.
policy.setExpires(expires)

// Only allow 'text'.
policy.setContentType('text/plain')

// Set content disposition response header.
policy.setContentDisposition('attachment; filename=text.txt')

// Only allow content size in range 1KB to 1MB.
policy.setContentLengthRange(1024, 1024*1024)

// Set key-value user defined metadata
policy.setUserMetaData({
  key: 'value'
})

POST your content from the browser using superagent:

minioClient.presignedPostPolicy(policy, function(err, data) {
  if (err) return console.log(err)

  var req = superagent.post(data.postURL)
  _.each(data.formData, function(value, key) {
    req.field(key, value)
  })

  // file contents.
  req.attach('file', '/path/to/hello.txt', 'hello.txt')

  req.end(function(err, res) {
    if (err) {
      return console.log(err.toString())
    }
    console.log('Upload successful.')
  })
})

5. Bucket Policy & Notification operations

Buckets are configured to trigger notifications on specified types of events and paths filters.

getBucketNotification(bucketName[, cb])

Fetch the notification configuration stored in the S3 provider and that belongs to the specified bucket name.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
callback(err, bucketNotificationConfig)	function	Callback function is called with non null err value in case of error. bucketNotificationConfig will be the object that carries all notification configurations associated to bucketName. If no callback is passed, a Promise is returned.

Example

minioClient.getBucketNotification('mybucket', function(err, bucketNotificationConfig) {
  if (err) return console.log(err)
  console.log(bucketNotificationConfig)
})

setBucketNotification(bucketName, bucketNotificationConfig[, callback])

Upload a user-created notification configuration and associate it to the specified bucket name.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
bucketNotificationConfig	BucketNotification	Javascript object that carries the notification configuration.
callback(err)	function	Callback function is called with non null err value in case of error. If no callback is passed, a Promise is returned.

Example

// Create a new notification object
var bucketNotification = new Minio.NotificationConfig();

// Setup a new Queue configuration
var arn = Minio.buildARN('aws', 'sqs', 'us-west-2', '1', 'webhook')
var queue = new Minio.QueueConfig(arn)
queue.addFilterSuffix('.jpg')
queue.addFilterPrefix('myphotos/')
queue.addEvent(Minio.ObjectReducedRedundancyLostObject)
queue.addEvent(Minio.ObjectCreatedAll)

// Add the queue to the overall notification object
bucketNotification.add(queue)

minioClient.setBucketNotification('mybucket', bucketNotification, function(err) {
  if (err) return console.log(err)
  console.log('Success')
})

removeAllBucketNotification(bucketName[, callback])

Remove the bucket notification configuration associated to the specified bucket.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket
callback(err)	function	Callback function is called with non null err value in case of error. If no callback is passed, a Promise is returned.

minioClient.removeAllBucketNotification('my-bucketname', function(e) {
  if (e) {
    return console.log(e)
  }
  console.log("True")
})

listenBucketNotification(bucketName, prefix, suffix, events)

Listen for notifications on a bucket. Additionally one can provider filters for prefix, suffix and events. There is no prior set bucket notification needed to use this API. This is an MinIO extension API where unique identifiers are registered and unregistered by the server automatically based on incoming requests.

Returns an EventEmitter, which will emit a notification event carrying the record.

To stop listening, call .stop() on the returned EventEmitter.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket
prefix	string	Object key prefix to filter notifications for.
suffix	string	Object key suffix to filter notifications for.
events	Array	Enables notifications for specific event types.

See here for a full example.

var listener = minioClient.listenBucketNotification('my-bucketname', 'photos/', '.jpg', ['s3:ObjectCreated:*'])
listener.on('notification', function(record) {
  // For example: 's3:ObjectCreated:Put event occurred (2016-08-23T18:26:07.214Z)'
  console.log('%s event occurred (%s)', record.eventName, record.eventTime)
  listener.stop()
})

getBucketPolicy(bucketName [, callback])

Get the bucket policy associated with the specified bucket. If objectPrefix is not empty, the bucket policy will be filtered based on object permissions as well.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket
callback(err, policy)	function	Callback function is called with non null err value in case of error. policy is bucket policy. If no callback is passed, a Promise is returned.

// Retrieve bucket policy of 'my-bucketname'
minioClient.getBucketPolicy('my-bucketname', function(err, policy) {
  if (err) throw err

  console.log(`Bucket policy file: ${policy}`)
})

setBucketPolicy(bucketName, bucketPolicy[, callback])

Set the bucket policy on the specified bucket. bucketPolicy is detailed here.

Parameters

Param	Type	Description
bucketName	string	Name of the bucket.
bucketPolicy	string	bucket policy.
callback(err)	function	Callback function is called with non null err value in case of error. If no callback is passed, a Promise is returned.

// Set the bucket policy of `my-bucketname`
minioClient.setBucketPolicy('my-bucketname', JSON.stringify(policy), function(err) {
  if (err) throw err

  console.log('Bucket policy set')
})

6. Custom Settings

setS3TransferAccelerate(endpoint)

Set AWS S3 transfer acceleration endpoint for all API requests hereafter. NOTE: This API applies only to AWS S3 and is a no operation for S3 compatible object storage services.

Parameters

Param	Type	Description
endpoint	string	Set to new S3 transfer acceleration endpoint.

7. HTTP request options

setRequestOptions(options)

Set the HTTP/HTTPS request options. Supported options are agent (http.Agent()), family (IP address family to use while resolving host or hostname), and tls related options ('agent', 'ca', 'cert', 'ciphers', 'clientCertEngine', 'crl', 'dhparam', 'ecdhCurve', 'honorCipherOrder', 'key', 'passphrase', 'pfx', 'rejectUnauthorized', 'secureOptions', 'secureProtocol', 'servername', 'sessionIdContext') documented here

// Do not reject self signed certificates.
minioClient.setRequestOptions({rejectUnauthorized: false})

7. Explore Further

• Build your own Shopping App Example