oyd
/
minio
6
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3865 Commits
1 Branch
0 Tags
89 MiB
 
 
 
 
 
 
Tag: Branch: Tree: 5af7bd6a01
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5af7bd6a01'
${ noResults }
minio/docs/admin-api
History
Harshavardhana 73f4f29110
docs: Restructure docs, move the files to their relevant location. (#3648) 		8 years ago
..
README.md docs: Restructure docs, move the files to their relevant location. (#3648) 8 years ago

README.md

Management REST API

Authentication

  • AWS signatureV4
  • We use "minio" as region. Here region is set only for signature calculation.

List of management APIs

  • Service

    • Restart
    • Status
    • SetCredentials

  • Locks

    • List
    • Clear

  • Healing

Service Management APIs

  • Restart

    • POST /?service
    • x-minio-operation: restart
    • Response: On success 200

  • Status

    • GET /?service
    • x-minio-operation: status
    • Response: On success 200, return json formatted object which contains StorageInfo and ServerVersion structures

  • SetCredentials

    • GET /?service
    • x-minio-operation: set-credentials
    • Response: Success 200
    • Possible error responses
      • ErrMethodNotAllowed MethodNotAllowed The specified method is not allowed against this resource. / 3L137 3L137
      • ErrAdminBadCred XMinioBadCred XMinioBadCred / 3L137 3L137
      • ErrInternalError InternalError We encountered an internal error, please try again. / 3L137 3L137

Lock Management APIs

  • ListLocks

    • GET /?lock&bucket=mybucket&prefix=myprefix&older-than=rel_time
    • x-minio-operation: list
    • Response: On success 200, json encoded response containing all locks held, older than rel_time. e.g, older than 3 hours.
    • Possible error responses

      • ErrInvalidBucketName InvalidBucketName The specified bucket is not valid. / 3L137 3L137

      • ErrInvalidObjectName XMinioInvalidObjectName Object name contains unsupported characters. Unsupported characters are `^*|" / 3L137 3L137

      • ErrInvalidDuration InvalidDuration Relative duration provided in the request is invalid. / 3L137 3L137

  • ClearLocks

    • POST /?lock&bucket=mybucket&prefix=myprefix&older-than=rel_time
    • x-minio-operation: clear
    • Response: On success 200, json encoded response containing all locks cleared, older than rel_time. e.g, older than 3 hours.
    • Possible error responses, similar to errors listed in ListLocks.
      • ErrInvalidBucketName
      • ErrInvalidObjectName
      • ErrInvalidDuration

Healing

  • ListBucketsHeal
    • GET /?heal
    • x-minio-operation: list-buckets