Minio Client SDK for .NET

Minio Client SDK provides higher level APIs for Minio and Amazon S3 compatible cloud storage services.For a complete list of APIs and examples, please take a look at the Dotnet Client API Reference.This document assumes that you have a working VisualStudio development environment.

Minimum Requirements

• .NET 4.5.2, .NetStandard1.6 or higher
• Visual Studio 2017 RC

Install from NuGet

To install Minio .NET package for .NET Framework, run the following command in Nuget Package Manager Console.

PM> Install-Package Minio 

To install Minio .NET package for .NetCore, run the following command in Nuget Package Manager Console.

PM> Install-Package Minio.NetCore

Minio Client Example

To connect to an Amazon S3 compatible cloud storage service, you will need to specify the following parameters.

Parameter	Description
endpoint	URL to object storage service.
accessKey	Access key is the user ID that uniquely identifies your account.
secretKey	Secret key is the password to your account.
secure	Enable/Disable HTTPS support.

The following examples uses a freely hosted public Minio service 'play.minio.io' for development purposes.

using Minio;

// Initialize the client with access credentials.
private static MinioClient minio = new MinioClient("play.minio.io:9000",
                "Q3AM3UQ867SPQQA43P2F",
                "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
                ).WithSSL();

// Create an async task for listing buckets.
var getListBucketsTask = minio.ListBucketsAsync();

// Iterate over the list of buckets.
foreach (Bucket bucket in getListBucketsTask.Result.Buckets)          
{                
    Console.Out.WriteLine(bucket.Name + " " + bucket.CreationDate.DateTime);
}

Complete File Uploader Example

This example program connects to an object storage server, creates a bucket and uploads a file to the bucket. To run the following example, click on [Link] and start the project

using System;
using Minio;
using Minio.Exceptions;
using Minio.DataModel;
using System.Threading.Tasks;

namespace FileUploader
{
    class FileUpload
    {
        static void Main(string[] args)
        {
            var endpoint  = "play.minio.io:9000";
            var accessKey = "Q3AM3UQ867SPQQA43P2F";
            var secretKey = "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG";
            try
            { 
                var minio = new MinioClient(endpoint, accessKey, secretKey).WithSSL();
                FileUpload.Run(minio).Wait();
            }
            catch (Exception ex)
            {
                Console.Out.WriteLine(ex.Message);
            }
            Console.ReadLine();
        }
        
        // File uploader task.
        private async static Task Run(MinioClient minio)
        {
            var bucketName = "mymusic";
            var location   = "us-east-1";
            var objectName = "golden-oldies.zip";
            var filePath = "C:\\Users\\username\\Downloads\\golden_oldies.mp3";
            var contentType = "application/zip";

            try
            {
                // Make a bucket on the server, if not already present.
                bool found = await minio.BucketExistsAsync(bucketName);
                if (!found)
                {
                    await minio.MakeBucketAsync(bucketName, location);
                }
                // Upload a file to bucket.
                await minio.PutObjectAsync(bucketName, objectName, filePath, contentType);  
                Console.Out.WriteLine("Successfully uploaded " + objectName );
            }
            catch (MinioException e)
            {
                Console.WriteLine("File Upload Error: {0}", e.Message);
            }
        }
    }
}

Running Minio Client Examples

On Windows

• Clone this repository and open the Minio.Sln in Visual Studio 2017.

• Enter your credentials and bucket name, object name etc.in Minio.Examples/Program.cs Uncomment the example test cases such as below in Program.cs to run an example.

  //Cases.MakeBucket.Run(minioClient, bucketName).Wait();

• Run the Minio.Client.Examples.NET452 or Minio.Client.Examples.NetCore project from Visual Studio

On Linux (Ubuntu 16.04)

Setting up Mono and .NETCore on Linux

NOTE: minio-dotnet requires mono 5.0.1 stable release and .NET Core 1.0 SDK to build on Linux.

• Install .NETCore and Mono for your distro. See sample script to install .NETCore and Mono for Ubuntu Xenial mono_install.sh

$ ./mono_install.sh    

Running Minio.Examples

• Clone this project.

$ git clone https://github.com/minio/minio-dotnet && cd minio-dotnet 

• Enter your credentials and bucket name, object name etc. in Minio.Examples/Program.cs Uncomment the example test cases such as below in Program.cs to run an example.

  //Cases.MakeBucket.Run(minioClient, bucketName).Wait();

• To run .NET4.5.2 example,

$ mono nuget.exe restore
$ msbuild /p:Configuration=.net4.5.2 /t:Clean 
$ msbuild /p:Configuration=.net4.5.2
$ ./Minio.Examples/Minio.Client.Examples.Net452/bin/.net4.5.2/Minio.Client.Examples.Net452.exe 

• To run .NetCore example,

$ dotnet msbuild /p:Configuration=.netcore
$ cd Minio.Examples/Minio.Client.Examples.Core
$ dotnet restore
$ dotnet run

Bucket Operations

• MakeBucket.cs
• ListBuckets.cs
• BucketExists.cs
• RemoveBucket.cs
• ListObjects.cs
• ListIncompleteUploads.cs

Bucket policy Operations

• GetPolicy.cs
• SetPolicy.cs

Bucket notification Operations

• GetBucketNotification.cs
• SetBucketNotification.cs
• RemoveAllBucketNotifications.cs

File Object Operations

• FGetObject.cs
• FPutObject.cs

Object Operations

• GetObject.cs
• GetPartialObject.cs
• PutObject.cs
• StatObject.cs
• RemoveObject.cs
• CopyObject.cs
• RemoveIncompleteUpload.cs

Presigned Operations

• PresignedGetObject.cs
• PresignedPutObject.cs
• PresignedPostPolicy.cs

Client Custom Settings

• SetAppInfo
• SetTraceOn
• SetTraceOff

Explore Further

• Complete Documentation
• Minio .NET SDK API Reference