MinIO Go Client SDK for Amazon S3 Compatible Cloud Storage

The MinIO Go Client SDK provides simple APIs to access any Amazon S3 compatible object storage.

This quickstart guide will show you how to install the MinIO client SDK, connect to MinIO, and provide a walkthrough for a simple file uploader. For a complete list of APIs and examples, please take a look at the Go Client API Reference.

This document assumes that you have a working Go development environment.

Download from Github

GO111MODULE=on go get github.com/minio/minio-go/v6

Initialize MinIO Client

MinIO client requires the following four parameters specified to connect to an Amazon S3 compatible object storage.

package main

import (
	"github.com/minio/minio-go/v6"
	"log"
)

func main() {
	endpoint := "play.min.io"
	accessKeyID := "Q3AM3UQ867SPQQA43P2F"
	secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
	useSSL := true

	// Initialize minio client object.
	minioClient, err := minio.New(endpoint, accessKeyID, secretAccessKey, useSSL)
	if err != nil {
		log.Fatalln(err)
	}

	log.Printf("%#v\n", minioClient) // minioClient is now setup
}

Quick Start Example - File Uploader

This example program connects to an object storage server, creates a bucket and uploads a file to the bucket.

We will use the MinIO server running at https://play.min.io in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

FileUploader.go

package main

import (
	"github.com/minio/minio-go/v6"
	"log"
)

func main() {
	endpoint := "play.min.io"
	accessKeyID := "Q3AM3UQ867SPQQA43P2F"
	secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
	useSSL := true

	// Initialize minio client object.
	minioClient, err := minio.New(endpoint, accessKeyID, secretAccessKey, useSSL)
	if err != nil {
		log.Fatalln(err)
	}

	// Make a new bucket called mymusic.
	bucketName := "mymusic"
	location := "us-east-1"

	err = minioClient.MakeBucket(bucketName, location)
	if err != nil {
		// Check to see if we already own this bucket (which happens if you run this twice)
		exists, errBucketExists := minioClient.BucketExists(bucketName)
		if errBucketExists == nil && exists {
			log.Printf("We already own %s\n", bucketName)
		} else {
			log.Fatalln(err)
		}
	} else {
		log.Printf("Successfully created %s\n", bucketName)
	}

	// Upload the zip file
	objectName := "golden-oldies.zip"
	filePath := "/tmp/golden-oldies.zip"
	contentType := "application/zip"

	// Upload the zip file with FPutObject
	n, err := minioClient.FPutObject(bucketName, objectName, filePath, minio.PutObjectOptions{ContentType:contentType})
	if err != nil {
		log.Fatalln(err)
	}

	log.Printf("Successfully uploaded %s of size %d\n", objectName, n)
}

Run FileUploader

go run file-uploader.go
2016/08/13 17:03:28 Successfully created mymusic
2016/08/13 17:03:40 Successfully uploaded golden-oldies.zip of size 16253413

mc ls play/mymusic/
[2016-05-27 16:02:16 PDT]  17MiB golden-oldies.zip

API Reference

The full API Reference is available here.

• Complete API Reference

API Reference : Bucket Operations

• MakeBucket
• ListBuckets
• BucketExists
• RemoveBucket
• ListObjects
• ListObjectsV2
• ListIncompleteUploads

API Reference : Bucket policy Operations

• SetBucketPolicy
• GetBucketPolicy

API Reference : Bucket notification Operations

• SetBucketNotification
• GetBucketNotification
• RemoveAllBucketNotification
• ListenBucketNotification (MinIO Extension)

API Reference : File Object Operations

• FPutObject
• FGetObject
• FPutObjectWithContext
• FGetObjectWithContext

API Reference : Object Operations

• GetObject
• PutObject
• GetObjectWithContext
• PutObjectWithContext
• PutObjectStreaming
• StatObject
• CopyObject
• RemoveObject
• RemoveObjects
• RemoveIncompleteUpload
• SelectObjectContent

API Reference : Presigned Operations

• PresignedGetObject
• PresignedPutObject
• PresignedHeadObject
• PresignedPostPolicy

API Reference : Client custom settings

• SetAppInfo
• SetCustomTransport
• TraceOn
• TraceOff

Full Examples

Full Examples : Bucket Operations

• makebucket.go
• listbuckets.go
• bucketexists.go
• removebucket.go
• listobjects.go
• listobjectsV2.go
• listincompleteuploads.go

Full Examples : Bucket policy Operations

• setbucketpolicy.go
• getbucketpolicy.go
• listbucketpolicies.go

Full Examples : Bucket lifecycle Operations

• setbucketlifecycle.go
• getbucketlifecycle.go

Full Examples : Bucket notification Operations

• setbucketnotification.go
• getbucketnotification.go
• removeallbucketnotification.go
• listenbucketnotification.go (MinIO Extension)

Full Examples : File Object Operations

• fputobject.go
• fgetobject.go
• fputobject-context.go
• fgetobject-context.go

Full Examples : Object Operations

• putobject.go
• getobject.go
• putobject-context.go
• getobject-context.go
• statobject.go
• copyobject.go
• removeobject.go
• removeincompleteupload.go
• removeobjects.go

Full Examples : Encrypted Object Operations

• put-encrypted-object.go
• get-encrypted-object.go
• fput-encrypted-object.go

Full Examples : Presigned Operations

• presignedgetobject.go
• presignedputobject.go
• presignedheadobject.go
• presignedpostpolicy.go

Explore Further

• Complete Documentation
• MinIO Go Client SDK API Reference

Contribute

Contributors Guide

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE and NOTICE for more information.