# Use S3-Compatible API

The OORT Storage S3 Gateway supports a API that is compatible with the basic data access model of the [Amazon S3 API](http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html).&#x20;

### **API Endpoint**

The OORT Storage S3-Compatible API endpoint URL is:

Standard：<https://s3-standard.oortech.com>

Archive：[https://s3-archive.oortech.com](https://s3-standard.oortech.com)

### **Authentication**

OORT Storage S3-Compatible API supports AWS v4 signature (AWS4-HMAC-SHA256) for authentication, supports AWS v2 signature, v4 signature is recommended.&#x20;

### **Https Protocol**

OORT Storage maintains strict https-only standards. This means that objects and API calls are only served over https. The port for this connection is the https standard port 443 . There is currently no way to disable this feature. Requests sent over the http protocol will be redirected to https.

### **Rate Limit**

The OORT Storage S3-Compatible API has an effective rate limit of 100 RPS (requests per second).

### **Supported API Methods**

<table><thead><tr><th width="317">Method Name</th><th>Method Description</th></tr></thead><tbody><tr><td>CreateBucket</td><td>Creates a new bucket.</td></tr><tr><td>ListBuckets</td><td>Returns a list of all buckets owned by the authenticated sender of the request.</td></tr><tr><td>DeleteBucket</td><td>Deletes the bucket. All objects in the bucket must be deleted before the bucket itself can be deleted.</td></tr><tr><td>ListObjects</td><td>Returns some or all (up to 1,000) of the objects in a bucket. We recommend that you use the newer version, ListObjectsV2</td></tr><tr><td>ListObjectsV2</td><td>Returns some or all (up to 1,000) of the objects in a bucket. </td></tr><tr><td>GetObject</td><td>Retrieves objects from OORT Storage. To use <code>GET</code>, you must have <code>READ</code> access to the object. </td></tr><tr><td>HeadObject</td><td>The HEAD action retrieves metadata from an object without returning the object itself.</td></tr><tr><td>PutObject</td><td>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</td></tr><tr><td>CopyObject</td><td>Creates a copy of an object that is already stored in OORT Storage.</td></tr><tr><td>DeleteObject</td><td>Delete an object from a bucket. If there isn't a null object, OORT Storage does not remove any objects but will still respond that the command was successful.</td></tr><tr><td>DeleteObjects</td><td>Delete an object from a bucket. If there isn't a null object, OORT Storage does not remove any objects but will still respond that the command was successful.</td></tr><tr><td>AbortMultipartUpload</td><td>This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID.</td></tr><tr><td>CreateMultipartUpload</td><td>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload.</td></tr><tr><td>CompleteMultipartUpload</td><td>Completes a multipart upload by assembling previously uploaded parts.</td></tr><tr><td>UploadPart</td><td>Uploads a part in a multipart upload.</td></tr><tr><td>UploadPartCopy</td><td>Uploads a part by copying data from an existing object as data source.</td></tr><tr><td>GetSignedUrl</td><td>Supports pre-signed URLs for downloading and uploading objects. </td></tr></tbody></table>

When a response payload is present, all responses are returned using UTF-8 encoded XML.

**Presigned URL**

The OORT Storage S3-Compatible API supports pre-signed URLs for downloading and uploading objects. Presigned URLs can be generated in several ways, including the AWS CLI and AWS SDKs.
