Replication
Console
Cache
Encryption
Versioning
Observability
Object Immutability
Key Management Server
S3 Compatibility
Identity + Access Mgt
Catalog
Object Prompt
Lifecycle
Firewall
AIHub
Erasure Code Calculator
Reference Hardware
Integrations with MinIO
Download MinIO Object Store
Events
JavaScript Client API Reference 
Initialize MinIO Client object.
MinIO
import * as Minio from 'minio'
const minioClient = new Minio.Client({
endPoint: 'play.min.io',
port: 9000,
useSSL: true,
accessKey: 'Q3AM3UQ867SPQQA43P2F',
secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})
AWS S3
import * as Minio from 'minio'
const s3Client = new Minio.Client({
endPoint: 's3.amazonaws.com',
accessKey: 'YOUR-ACCESSKEYID',
secretKey: 'YOUR-SECRETACCESSKEY',
})
1. Constructor
new Minio.Client ({endPoint, port, useSSL, accessKey, secretKey, region, transport, sessionToken, partSize})
Parameters
Example
Create client for MinIO
import * as Minio from 'minio'
const minioClient = new Minio.Client({
endPoint: 'play.min.io',
port: 9000,
useSSL: true,
accessKey: 'Q3AM3UQ867SPQQA43P2F',
secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})
Create client for AWS S3
import * as Minio from 'minio'
const s3Client = new Minio.Client({
endPoint: 's3.amazonaws.com',
accessKey: 'YOUR-ACCESSKEYID',
secretKey: 'YOUR-SECRETACCESSKEY',
})
Create client with temporary credentials
import * as Minio from 'minio'
const s3Client = new Minio.Client({
endPoint: 's3.amazonaws.com',
accessKey: 'YOUR-TEMP-ACCESSKEYID',
secretKey: 'YOUR-TEMP-SECRETACCESSKEY',
sessionToken: 'YOUR-TEMP-SESSIONTOKEN',
})
Create client with custom HTTPS Agent
import * as Minio from 'minio'
import * as fs from 'fs'
import * as https from 'https'
const s3Client = new Minio.Client({
endPoint: 'play.min.io',
port: 9000,
useSSL: true,
accessKey: 'Q3AM3UQ867SPQQA43P2F',
secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
transportAgent: new https.Agent({
timeout: 10000,
ca: fs.readFileSync('path/to/ca.cert'),
cert: fs.readFileSync('path/to/public.cert'),
key: fs.readFileSync('path/to/secret.key'),
keepAlive: false,
}),
})
Note: The below examples may rely on top level await.
2. Bucket operations
async makeBucket(bucketName, [region, makeOpts]): Promise
Creates a new bucket.
Parameters
Example
await minioClient.makeBucket('mybucket', 'us-east-1')
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()
Lists all buckets.
Parameters
NIL
Returns Array of Objects with the format:-
Example
Please refer to: list-buckets.mjs
try {
const buckets = await minioClient.listBuckets()
console.log('Success', buckets)
} catch (err) {
console.log(err.message)
}
async bucketExists(bucketName): Promise
Checks if a bucket exists.
Parameters
Example
const exists = await minioClient.bucketExists('mybucket')
if (exists) {
return console.log('Bucket exists.')
}
removeBucket(bucketName[, callback])
Removes a bucket.
Parameters
Example
try {
await minioClient.removeBucket('mybucket')
console.log('Bucket removed successfully.')
} catch (err) {
console.log('unable to remove bucket.')
}
listObjects(bucketName, prefix, recursive [,listOpts])
Lists all objects in a bucket.
Parameters
Return Value
The object is of the format:
Example
const data = []
const stream = minioClient.listObjects('mybucket', '', true)
stream.on('data', function (obj) {
data.push(obj)
})
stream.on('end', function () {
console.log(data)
})
stream.on('error', function (err) {
console.log(err)
})
Example1 To get Object versions
const data = []
const stream = minioClient.listObjects('mybucket', '', true, { IncludeVersion: true })
stream.on('data', function (obj) {
data.push(obj)
})
stream.on('end', function () {
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
Return Value
The object is of the format:
Example
const 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
Return Value
The object is of the format:
Example
const 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
Return Value
Example
const 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
Example
const versionInfo = await minioClient.getBucketVersioning('bucketname')
console.log('Success ', versionInfo)
setBucketVersioning(bucketName, versioningConfig)
Set Versioning state on a Bucket
Parameters
Example
const versioningConfig = { Status: 'Enabled' }
await minioClient.setBucketVersioning('bucketname', versioningConfig)
setBucketReplication(bucketName, replicationConfig)
Set replication config on a Bucket
Parameters
Example
const arnFromMcCli = 'arn:minio:replication::b22d653b-e4fb-4c5d-8140-7694c8e72ed4:dest-bucket'
const replicationConfig = {
role: arnFromMcCli,
rules: [
{
ID: 'cisea130mbms6splbmg0',
Status: 'Enabled',
Priority: 1,
DeleteMarkerReplication: { Status: 'Enabled' },
DeleteReplication: { Status: 'Enabled' },
Destination: {
Bucket: 'arn:aws:s3:::dest-bucket',
StorageClass: 'REDUCED_REDUNDANCY',
},
SourceSelectionCriteria: { ReplicaModifications: { Status: 'Enabled' } },
Filter: {
//Possible values.
// Prefix: '/',
// Tag: [{ 'Key': 'key1', 'Value': 'value1' }, { 'Key': 'key2', 'Value': 'value2' }],//if only this, => 'DeleteMarkerReplication': { 'Status': 'Disabled' },
And: {
Prefix: '/',
Tag: [
{ Key: 'key1', Value: 'value1' },
{ Key: 'key2', Value: 'value2' },
],
},
},
ExistingObjectReplication: { Status: 'Enabled' },
},
],
}
await s3Client.setBucketReplication('source-bucket', replicationConfig)
getBucketReplication(bucketName)
Get replication config of a Bucket
Parameters
Example
const replicatinConfig = await minioClient.getBucketReplication('source-bucket')
console.log(replicatinConfig)
removeBucketReplication(bucketName)
Remove replication config of a Bucket
Parameters
Example
await minioClient.removeBucketReplication('source-bucket')
removeBucketTagging(bucketName, callback)
Remove Tags on a Bucket
Parameters
Example
await minioClient.removeBucketTagging('bucketname')
getBucketTagging(bucketName)
Gets Tags on a Bucket
Parameters
Example
const tagList = await minioClient.getBucketTagging('bucketname')
console.log(tagList)
setBucketLifecycle(bucketName, lifecycleConfig)
Set Lifecycle Configuration on a Bucket
Parameters
Example
const lifecycleConfig = {
Rule: [
{
ID: 'Transition and Expiration Rule',
Status: 'Enabled',
Filter: {
Prefix: '',
},
Expiration: {
Days: '3650',
},
},
],
}
await minioClient.setBucketLifecycle('bucketname', lifecycleConfig)
getBucketLifecycle(bucketName)
Get Lifecycle Configuration of a Bucket
Parameters
Example
await minioClient.getBucketLifecycle('bucketname')
removeBucketLifecycle(bucketName)
Remove Lifecycle Configuration of a Bucket
Parameters
Example
await minioClient.removeBucketLifecycle('bucketname')
setObjectLockConfig(bucketName, lockConfig [, callback])
Set Object lock config on a Bucket
Parameters
Example 1
await minioClient.setObjectLockConfig('my-bucketname', { mode: 'COMPLIANCE', unit: 'Days', validity: 10 })
Example 2 To reset/remove object lock config on a bucket.
await s3Client.setObjectLockConfig('my-bucketname', {})
getObjectLockConfig(bucketName [, callback])
Get Lock config on a Bucket
Parameters
**Example ** Get object lock configuration on a Bucket
await minioClient.getObjectLockConfig('my-bucketname')
setBucketEncryption(bucketName [,encryptionConfig])
Set encryption configuration on a Bucket
Parameters
**Example ** Set Encryption configuration on a Bucket
await s3Client.setBucketEncryption('my-bucketname')
Example 1 Set Encryption configuration on a Bucket with an Algorithm
await s3Client.setBucketEncryption('my-bucketname', {
Rule: [{ ApplyServerSideEncryptionByDefault: { SSEAlgorithm: 'AES256' } }],
})
getBucketEncryption(bucketName)
Get encryption configuration of a Bucket
Parameters
**Example ** Get Encryption configuration of a Bucket
await s3Client.getBucketEncryption('my-bucketname')
removeBucketEncryption(bucketName)
Remove encryption configuration of a Bucket
Parameters
**Example ** Remove Encryption configuration of a Bucket
await s3Client.removeBucketEncryption('my-bucketname')
3. Object operations
getObject(bucketName, objectName, getOpts)
Downloads an object as a stream.
Parameters
Return Value
Example
let size = 0
const dataStream = await minioClient.getObject('mybucket', 'photo.jpg')
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.
let size = 0
const dataStream = await minioClient.getObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' })
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 Server Side Encrypted object.
let size = 0
const dataStream = await minioClient.getObject('mybucket', 'photo.jpg', {
SSECustomerAlgorithm: 'AES256',
SSECustomerKey: 'YOUR_KEY',
SSECustomerKeyMD5: 'YOUR_MD5',
})
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
Return Value
Example
let size = 0
// reads 30 bytes from the offset 10.
const dataStream = await minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30)
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
const versionedObjSize = 0
// reads 30 bytes from the offset 10.
const dataStream = await minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, { versionId: 'my-versionId' })
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)
})
Example To get a Server Side Encrypted object.
const versionedObjSize = 0
// reads 30 bytes from the offset 10.
const dataStream = await minioClient.getPartialObject('mybucket', 'photo.jpg', 10, 30, {
SSECustomerAlgorithm: 'AES256',
SSECustomerKey: 'YOUR_KEY',
SSECustomerKeyMD5: 'YOUR_MD5',
})
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
Return Value
Example
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')
})
Example To Stream a Server Side Encrypted object into a file.
minioClient.fGetObject(
bucketName,
objNameValue,
'./download/MyImage.jpg',
{
SSECustomerAlgorithm: 'AES256',
SSECustomerKey: 'YOUR_KEY',
SSECustomerKeyMD5: 'YOUR_MD5',
},
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
Return Value
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.
import * as Fs from 'fs'
const file = '/tmp/40mbfile'
const fileStream = Fs.createReadStream(file)
const 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
Example
const 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
Return Value
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.
const file = '/tmp/40mbfile'
const 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(targetBucketName, targetObjectName, sourceBucketNameAndObjectName [,conditions])
Copy a source object into a new object in the specified bucket.
Parameters
Example
const conds = new Minio.CopyConditions()
conds.setMatchETag('bd891862ea3e22c93ed53a098218791d')
await minioClient.copyObject('mybucket', 'newobject', '/mybucket/srcobject', conds)
statObject(bucketName, objectName, statOpts[, callback])
Gets metadata of an object.
Parameters
Return Value
Example
const stat = await minioClient.statObject('mybucket', 'photo.jpg')
console.log(stat)
Example stat on a version of an object
const stat = await minioClient.statObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' })
console.log(stat)
removeObject(bucketName, objectName [, removeOpts])
Removes an object.
Parameters
Example 1
;(async function () {
await minioClient.removeObject('mybucket', 'photo.jpg')
console.log('Removed the object')
})()
Example 2 Delete a specific version of an object
;(async function () {
try {
await minioClient.removeObject('mybucket', 'photo.jpg', { versionId: 'my-versionId' })
console.log('Removed the object')
} catch (err) {
console.log('Unable to remove object', err)
}
})()
Example 3
Remove an object version locked with retention mode GOVERNANCE using the governanceBypass remove option
;(async function () {
await s3Client.removeObject('my-bucketname', 'my-objectname', { versionId: 'my-versionId', governanceBypass: true })
console.log('Success')
})()
removeObjects(bucketName, objectsList)
Remove all objects in the objectsList.
Parameters
Example
const objectsList = []
// List all object paths in bucket my-bucketname.
const 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', async () => {
await s3Client.removeObjects(bucket, objectsList)
})
Example1
With versioning Support
const objectsList = []
const bucket = 'my-bucket'
const prefix = 'my-prefix'
const recursive = false
const 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', async () => {
await s3Client.removeObjects(bucket, objectsList)
})
removeIncompleteUpload(bucketName, objectName)
Removes a partially uploaded object.
Parameters
Example
await minioClient.removeIncompleteUpload('mybucket', 'photo.jpg')
async putObjectRetention(bucketName, objectName [, retentionOpts])
Apply retention on an object.
Parameters
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'
await minioClient.putObjectRetention(bucketName, objectName, {
Mode: 'GOVERNANCE',
retainUntilDate: retainUntilDate.toISOString(),
versionId: versionId,
})
getObjectRetention(bucketName, objectName [, getOpts])
Get retention config of an object
Parameters
Example 1
const retentionInfo = await minioClient.getObjectRetention('bucketname', 'objectname')
console.log(retentionInfo)
Example 2
const retInfoForVersionId = await minioClient.getObjectRetention('bucketname', 'objectname', {
versionId: 'my-versionId',
})
console.log(retInfoForVersionId)
removeObjectTagging(bucketName, objectName[, removeOpts])
Remove Tags on an Object
Parameters
Example
await minioClient.removeObjectTagging('bucketname', 'object-name')
Example1 Remove tags on a version of an object.
await minioClient.removeObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' })
getObjectTagging(bucketName, objectName[, getOpts])
Get Tags of an Object
Parameters
Example
console.log(await minioClient.getObjectTagging('bucketname', 'object-name'))
Example1 Get tags on a version of an object.
console.log(await minioClient.getObjectTagging('bucketname', 'object-name', { versionId: 'my-object-version-id' }))
getObjectLegalHold(bucketName, objectName, getOpts)
Get legal hold on an object.
Parameters
Example 1
Get Legal hold of an object.
const legalholdStatus = await minioClient.getObjectLegalHold('bucketName', 'objectName')
Example 2
Get Legal hold of an object with versionId.
const legalholdStatus = await minioClient.getObjectLegalHold('bucketName', 'objectName', {
versionId: 'my-obj-version-uuid',
})
setObjectLegalHold(bucketName, objectName, [,setOpts])
Set legal hold on an object.
Parameters
Example 1
Set Legal hold of an object.
const legalholdStatus = await minioClient.setObjectLegalHold('bucketName', 'objectName', { Status: 'ON' })
Example 2
Set Legal hold of an object with versionId.
const legalholdStatus = await minioClient.setObjectLegalHold('bucketName', 'objectName', {
Status: 'ON',
versionId: 'my-obj-version-uuid',
})
composeObject(destObjConfig, sourceObjectList)
Compose an object from parts
Parameters
Example 1
Compose an Object from its parts .
import * as minio from 'minio'
const sourceList = [
new minio.CopySourceOptions({
Bucket: 'source-bucket',
Object: 'parta',
}),
new minio.CopySourceOptions({
Bucket: 'source-bucket',
Object: 'partb',
}),
new minio.CopySourceOptions({
Bucket: 'source-bucket',
Object: 'partc',
}),
new minio.CopySourceOptions({
Bucket: 'source-bucket',
Object: 'partd',
}),
]
const destOption = new minio.CopyDestinationOptions({
Bucket: 'dest-bucket',
Object: '100MB.zip',
})
//using Promise style.
await minioClient.composeObject(destOption, sourceList)
selectObjectContent(bucketName, objectName, selectOpts)
Select contents of an object (S3 Select).
Parameters
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 },
}
const res = await minioClient.selectObjectContent('bucketName', 'objectName', selectOpts)
console.log(res)
4. Presigned operations
Presigned URLs are generated for temporary download/upload access to private objects.
presignedUrl(httpMethod, bucketName, objectName[, expiry, reqParams, requestDate])
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
Example1
// presigned url for 'getObject' method.
// expires in a day.
const presignedUrl = await minioClient.presignedUrl('GET', 'mybucket', 'hello.txt', 24 * 60 * 60)
console.log(presignedUrl)
Example2
// presigned url for 'listObject' method.
// Lists objects in 'myBucket' with prefix 'data'.
// Lists max 1000 of them.
await minioClient.presignedUrl('GET', 'mybucket', '', 1000, { prefix: 'data', 'max-keys': 1000 })
Example 3
// Get Object with versionid
await minioClient.presignedUrl('GET', 'mybucket', '', 1000, { versionId: '10fa9946-3f64-4137-a58f-888065c0732e' })
presignedGetObject(bucketName, objectName[, expiry, respHeaders, requestDate])
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
Example
// expires in a day.
const presignedUrl = await minioClient.presignedGetObject('mybucket', 'hello.txt', 24 * 60 * 60)
console.log(presignedUrl)
presignedPutObject(bucketName, objectName [,expiry])
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
Example
// expires in a day.
const presignedUrl = await minioClient.presignedPutObject('mybucket', 'hello.txt', 24 * 60 * 60)
console.log(presignedUrl)
presignedPostPolicy(policy)
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
Create policy:
const 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')
const 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:
const { postURL, formData } = await minioClient.presignedPostPolicy(policy)
const req = superagent.post(postURL)
_.each(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
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
Example
// Create a new notification object
const bucketNotification = new Minio.NotificationConfig()
// Setup a new Queue configuration
const arn = Minio.buildARN('aws', 'sqs', 'us-west-2', '1', 'webhook')
const 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
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
See here for a full example.
const 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()
})
async getBucketPolicy(bucketName: string): Promise
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
// Retrieve bucket policy of 'my-bucketname'
const policy = await minioClient.getBucketPolicy('my-bucketname')
console.log(`Bucket policy file: ${policy}`)
async setBucketPolicy(bucketName, bucketPolicy): Promise
Set the bucket policy on the specified bucket. bucketPolicy is detailed here.
Parameters
// Set the bucket policy of `my-bucketname`
await minioClient.setBucketPolicy('my-bucketname', JSON.stringify(policy))
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
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
