diff --git a/docs/admin-api/README.md b/docs/admin-api/README.md deleted file mode 100644 index b197ab859..000000000 --- a/docs/admin-api/README.md +++ /dev/null @@ -1,131 +0,0 @@ -# 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 - ```xml - - MethodNotAllowed - The specified method is not allowed against this resource. - - - / - 3L137 - 3L137 - - ``` - - ErrAdminBadCred - ```xml - - XMinioBadCred - XMinioBadCred - - - / - 3L137 - 3L137 - - ``` - - ErrInternalError - ```xml - - InternalError - We encountered an internal error, please try again. - - - / - 3L137 - 3L137 - - ``` - - -### Lock Management APIs -* ListLocks - - GET /?lock&bucket=mybucket&prefix=myprefix&duration=duration - - x-minio-operation: list - - Response: On success 200, json encoded response containing all locks held, for longer than duration. - - Possible error responses - - ErrInvalidBucketName - ```xml - - InvalidBucketName - The specified bucket is not valid. - - - / - 3L137 - 3L137 - - ``` - - ErrInvalidObjectName - ```xml - - XMinioInvalidObjectName - Object name contains unsupported characters. Unsupported characters are `^*|\" - - - / - 3L137 - 3L137 - - ``` - - - ErrInvalidDuration - ```xml - - InvalidDuration - Duration provided in the request is invalid. - - - / - 3L137 - 3L137 - - ``` - - -* ClearLocks - - POST /?lock&bucket=mybucket&prefix=myprefix&duration=duration - - x-minio-operation: clear - - Response: On success 200, json encoded response containing all locks cleared, for longer than duration. - - Possible error responses, similar to errors listed in ListLocks. - - ErrInvalidBucketName - - ErrInvalidObjectName - - ErrInvalidDuration - -### Healing - -* ListBucketsHeal - - GET /?heal - - x-minio-operation: list-buckets