minio/minio
Admin API
The admin API is mounted under /minio/admin/v3 by cmd/admin-router.go. It's the surface area mc admin, the embedded console, and madmin-go clients consume.
Inventory (selected)
| Area | Sample endpoints | File |
|---|---|---|
| Server info | GET /info, GET /storageinfo, GET /datausageinfo |
cmd/admin-server-info.go, cmd/admin-handlers.go |
| Configuration KV | GET /config-kv, POST /config-kv |
cmd/admin-handlers-config-kv.go |
| User and policy IAM | GET/POST /users, GET/POST /policies, GET/POST /service-accounts, POST /attach-policy |
cmd/admin-handlers-users.go |
| LDAP / OIDC | GET /idp/ldap/policy-entities, POST /idp/ldap/policy/{name} |
cmd/admin-handlers-idp-ldap.go, cmd/admin-handlers-idp-openid.go |
| Bucket admin | POST /bucket/quota, POST /bucket/remote/{name}, GET /bucket/replication-config-import |
cmd/admin-bucket-handlers.go |
| Heal | POST /heal/{bucket}/{prefix}, GET /heal/{bucket}/{prefix}?status=true |
cmd/admin-heal-ops.go |
| Pools (decom + rebalance) | GET /pools/list, POST /pools/decommission, POST /pools/rebalance |
cmd/admin-handlers-pools.go |
| Site replication | POST /site-replication/add, GET /site-replication/info, POST /site-replication/edit |
cmd/admin-handlers-site-replication.go |
| Trace / profile | GET /trace, POST /profile?action=start |
cmd/admin-handlers.go |
| Speed test | POST /speedtest |
cmd/speedtest.go, cmd/perf-tests.go |
| Tiers | GET/POST /tier, POST /tier-stats |
cmd/tier-handlers.go |
| Batch jobs | POST /start-job, GET /describe-job, POST /cancel-job |
cmd/batch-handlers.go |
| Inspect / support | GET /inspect-data |
cmd/admin-handlers.go |
The full list lives in cmd/admin-router.go.
Auth
Every endpoint goes through validateAdminReq (cmd/admin-handler-utils.go), which checks SigV4 + the action-specific admin policy permission (pkg/v3/policy admin actions).
Wire format
JSON request / response bodies. Errors follow a small typed envelope: { "Code": "...", "Message": "...", "RequestID": "..." }.
Idempotency and safety
- Most write endpoints accept
force=truefor destructive operations (e.g.attach-policy). - Heal jobs return a job ID; status polling uses
?status=true. - Decommission and rebalance are paused with explicit endpoints; their progress survives restarts.
Streaming endpoints
GET /trace— server-sent events of every traced operation.GET /listen— bucket event stream.GET /admin/v3/profile?action=stop— returns a tarball of the profiles.
See also
- Admin API — the system-level view.
- Healing for the heal endpoint flow.
- Site replication for the site-replication endpoints.
- Batch jobs for
start-job.
Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.