MyFavMirrors
/
minio
mirror of https://github.com/minio/minio.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
minio/docs/api/minio.md

215 lines
3.7 KiB
Markdown
Raw Normal View History

Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
# Minio API
Adding minio api documentation
2015-02-02 18:41:21 -05:00
## General Overview
Minio stores and retrieves data in a logical format based upon REST
based URLs.
Adding JSON Example for GET /
2015-02-04 17:04:41 -05:00
### Note about examples:
XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly.
Adding minio api documentation
2015-02-02 18:41:21 -05:00
```
Form:
http://minio.example.com/{bucket}/{path:.*}
Examples:
http://minio.example.com/bucket/object
http://minio.example.com/bucket/path/to/object
http://minio.example.com/bucket2/path/to/object
```
Minor header update, renaming '/' to 'GET /'
2015-02-02 19:22:37 -05:00
## GET /
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
List buckets accessible by the user.
Adding JSON Example for GET /
2015-02-04 17:04:41 -05:00
The default output is XML. JSON output may also be requested by adding the following header:
```
Accept: "application/json"
```
Adding minio api documentation
2015-02-02 18:41:21 -05:00
Example:
```
GET / HTTP/1.1
```
```
HTTP/1.1 200 OK
Connection: close
Content-Type: application/xml
Server: Minio
Date: Mon, 02 Feb 2015 22:09:00 GMT
Content-Length: 306
<ListAllMyBucketsResult>
<Owner>
<ID>minio</ID>
<DisplayName>minio</DisplayName>
</Owner>
<Buckets>
<Bucket>
<Name>bucket</Name>
<CreationDate>2015-01-30T15:20:09.013Z</CreationDate>
</Bucket>
<Bucket>
<Name>minio</Name>
<CreationDate>2015-01-27T17:46:28.264Z</CreationDate>
</Bucket>
</Buckets>
</ListAllMyBucketsResult>
```
Adding JSON Example for GET /
2015-02-04 17:04:41 -05:00
```
GET / HTTP/1.1
Accept: application/json
```
```
HTTP/1.1 200 OK
Connection: close
Content-Type: application/json
Server: Minio
Date: Wed, 04 Feb 2015 21:59:10 GMT
Content-Length: 223
{
"Owner" : {
"ID" : "minio"
"DisplayName" : "minio",
},
"Buckets" : {
"Bucket" : [
{
"Name" : "bucket",
"CreationDate" : "2015-01-30T15:20:09.013Z"
},
{
"Name" : "minio",
"CreationDate" : "2015-02-02T14:52:34.914Z"
}
]
}
}
```
Adding minio api documentation
2015-02-02 18:41:21 -05:00
## GET /{bucket}/
Lists objects in a bucket.
Example:
```
GET /minio/ HTTP/1.1
```
```
HTTP/1.1 200 OK
Connection: close
Content-Type: application/xml
Server: Minio
Adding additional entry into bucket list in docs
2015-02-03 20:36:14 -05:00
Date: Tue, 03 Feb 2015 00:57:59 GMT
Content-Length: 579
Adding minio api documentation
2015-02-02 18:41:21 -05:00
<ListBucketResult>
<Name>minio</Name>
<Marker/>
<MaxKeys>1000</MaxKeys>
<IsTruncated>false</IsTruncated>
Adding additional entry into bucket list in docs
2015-02-03 20:36:14 -05:00
<Contents>
<Key>hello</Key>
<LastModified>2015-02-02T14:52:34.914Z</LastModified>
<ETag>minio#hello</ETag>
<Size>75</Size>
<StorageClass>STANDARD</StorageClass>
<Owner>
<ID>minio</ID>
<DisplayName>minio</DisplayName>
</Owner>
</Contents>
Adding minio api documentation
2015-02-02 18:41:21 -05:00
<Contents>
<Key>one</Key>
<LastModified>2015-01-27T17:46:28.264Z</LastModified>
<ETag>minio#one</ETag>
<Size>4096</Size>
<StorageClass>STANDARD</StorageClass>
<Owner>
<ID>minio</ID>
<DisplayName>minio</DisplayName>
</Owner>
</Contents>
</ListBucketResult>
```
## PUT /{bucket}/
Example:
```
PUT /books/ HTTP/1.1
```
```
HTTP/1.1 200 OK
Connection: close
Server: Minio
Date: Mon, 02 Feb 2015 22:05:43 GMT
Content-Length: 0
Content-Type: text/plain; charset=utf-8
```
EXAMPLE
## GET /{bucket}/{object}
```
GET /minio/hello HTTP/1.1
```
```
HTTP/1.1 200 OK
Connection: close
Content-Length: 75
Content-Type: text/plain
Etag: minio#hello
Last-Modified: Mon, 02 Feb 2015 14:52:34 PST
Server: Minio
Date: Mon, 02 Feb 2015 22:59:51 GMT
<?xml version="1.0"?>
<html>
<head/>
<body>Hello World!</body>
</html>
```
Retrieves an object from a bucket
## HEAD /{bucket}/{object}
```
HEAD /minio/hello HTTP/1.1
```
```
HTTP/1.1 200 OK
Connection: close
Content-Length: 75
Content-Type: text/plain
Etag: minio#hello
Last-Modified: Mon, 02 Feb 2015 14:52:34 PST
Server: Minio
Date: Mon, 02 Feb 2015 23:02:30 GMT
```
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
Retrieves meta-data about an object
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
## PUT /{bucket}/{object}
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
Stores an object
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
```
PUT /minio/hello HTTP/1.1
Content-Length: 75
Initial mkdocs configuration
2015-02-02 16:48:39 -05:00
Adding minio api documentation
2015-02-02 18:41:21 -05:00
<?xml version="1.0"?>
<html>
<head/>
<body>Hello World!</body>
</html>
```
```
HTTP/1.1 200 OK
```