S3 API Compatibility

This page documents S3 APIs supported by MinIO Object Storage. For reference documentation on any given API, see the corresponding documentation for Amazon S3.

Object APIs

• CopyObject
• DeleteObject
• DeleteObjects
• DeleteObjectTagging
• GetObject
• GetObjectAttributes
• GetObjectTagging
• HeadObject
• ListObjects
• ListObjectsV2
• ListObjectVersions
• PutObject
• PutObjectTagging
• RestoreObject
• SelectObjectContent

Object Locking

• GetObjectRetention
• PutObjectRetention
• GetObjectLegalHold
• PutObjectLegalHold
• GetObjectLockConfiguration
• PutObjectLockConfiguration

Unsupported API Object Endpoints

GetObjectAcl
PutObjectAcl

Multipart Uploads

• AbortMultipartUpload
• CompleteMultipartUpload
• CreateMultipartUpload
• ListMultipartUploads
• ListParts
• UploadPart
• UploadPartCopy

Differences from S3 APIs for Multipart Uploads

• ListMultipartUploads requires the exact object name as a prefix.
• The AbortIncompleteMultipartUpload lifecycle action is not supported with PutBucketLifecycle.

Bucket APIs

• CreateBucket
• DeleteBucket
• DeleteBucketEncryption
• DeleteBucketTagging
• GetBucketEncryption
• GetBucketLocation
• GetBucketTagging
• GetBucketVersioning
• HeadBucket
• ListBuckets
• ListDirectoryBuckets
• PutBucketEncryption
• PutBucketTagging
• PutBucketVersioning

Bucket Replication

• GetBucketReplication
• PutBucketReplication
• DeleteBucketReplication

Bucket Lifecycle

• GetBucketLifecycle
• GetBucketLifecycleConfiguration
• PutBucketLifecycle
• PutBucketLifecycleConfiguration
• DeleteBucketLifecycle

Bucket Notifications

• GetBucketNotification
• GetBucketNotificationConfiguration
• PutBucketNotification
• PutBucketNotificationConfiguration

Bucket Policies

• GetBucketPolicy
• GetBucketPolicyStatus
• PutBucketPolicy
• DeleteBucketPolicy

Unsupported API Bucket Operations

GetBucketInventoryConfiguration
PutBucketInventoryConfiguration
DeleteBucketInventoryConfiguration
PutBucketCors
DeleteBucketCors
GetBucketMetricsConfiguration
PutBucketMetricsConfiguration
DeleteBucketMetricsConfiguration
PutBucketWebsite
GetBucketLogging
PutBucketLogging
PutBucketAccelerateConfiguration
DeleteBucketAccelerateConfiguration
PutBucketRequestPayment
DeleteBucketRequestPayment
PutBucketAcl
HeadBucketAcl
GetPublicAccessBlock
PutPublicAccessBlock
DeletePublicAccessBlock
GetBucketOwnershipControls
PutBucketOwnershipControls
DeleteBucketOwnershipControls
GetBucketIntelligentTieringConfiguration
PutBucketIntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurations
DeleteBucketIntelligentTieringConfiguration
GetBucketAnalyticsConfiguration
PutBucketAnalyticsConfiguration
ListBucketAnalyticsConfigurations
DeleteBucketAnalyticsConfiguration
CreateSession

MinIO alternatives for unsupported Bucket resources

• For calls to BucketACL or ObjectACL operations, use Policies.
• Calls to BucketCORS operations are not needed because CORS is enabled by default on all buckets for all HTTP verbs.
• For calls to BucketWebsite operations, use caddy or nginx.
• For calls to BucketAnalytics, BucketMetrics, or BucketLogging operations, use Bucket Notifications.