mc-admin.md

Management REST API

Authentication

• AWS signatureV2

Versioning

• Standard REST API versioning

List of management APIs

• Service

  • Shutdown
  • Restart
  • Status

• Locks

  • List
  • Clear

• Healing

Service Management APIs

• Shutdown

  • POST /minio/control/v1/service
  • Content-Type: application/json
  • Body: { Cmd: "Stop" }
  • Response: On success 200

• Restart

  • POST /minio/control/v1/service
  • Content-Type: application/json
  • Body: { Cmd : "Restart" }
  • Response: On success 200

• Status

  • GET /minio/control/v1/service
  • Response: On success 200, 404 if not online.
  • TBD: send PID of minio server process/processes depending on setup type?

Lock Management APIs

• List
  • GET /minio/control/v1/lock?older-than=rel_time
  • GET /minio/control/v1/lock/bucket?prefix=prefix&?older-than=rel_time
  • Response: On success 200, json encoded response containing all locks held, older than rel_time. e.g, older than 3 hours.

Healing Management APIs

• StorageFormat

  • POST /minio/control/v1/heal
  • Content-Type: application/json
  • Body: { target : { "diskMetadata"}}
  • Response: On success 200, indicate if storage format needed to be fixed or not, and successfully fixed or not

• HealBucket

  • POST /minio/control/v1/heal
  • Content-Type: application/json
  • Body: { target: { "bucket" : { name : "testbucket" }}}
  • Response: On success 200, indicate if there are buckets that needed to be healed and if they were successfully healed

• HealObject

  • POST /minio/control/v1/heal
  • Content-Type: application/json
  • Body: { target: {"object": { prefix: "objectprefix", bucket: "testbucket" }}}
  • Response: On success 200, indicate if there are any objects that are needed to be healed, and if they are successfully healed

• ListObjectsHeal

  • GET /mminio/control/v1/heal/bucket?prefix=prefix&marker=marker&delimiter=delimiter&maxKey=1000
  • Content-Type: application/json
  • Response: On success 200, list all objects that need to be healed