# RustFS Rustfs API

**Canonical:** https://apis.io/apis/rustfs/rustfs-rustfs-api/  
**Provider:** RustFS — https://apis.io/providers/rustfs/  
**Base URL:** http://localhost:9000  
**Documentation:** https://docs.rustfs.com/en/developer

RustFS Rustfs API is one of 4 APIs that [RustFS](https://apis.io/providers/rustfs/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Rustfs. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Rustfs API from RustFS — 13 operation(s) for rustfs.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| POST | `/rustfs/admin/v3/background-heal/status` | Check status of background healing operations |
| DELETE | `/rustfs/admin/v3/group/{group}` | Delete group |
| GET | `/rustfs/admin/v3/idp/builtin/policy-entities` | List policy bindings showing which users/groups have which policies |
| POST | `/rustfs/admin/v3/idp/builtin/policy/{policyid}` | Attach policies to a user or group |
| GET | `/rustfs/admin/v3/oidc/providers` | Check that the OIDC provider is available after restarting RustFS |
| GET | `/rustfs/admin/v3/pools/{poolid}` | List all pools in the cluster |
| POST | `/rustfs/admin/v3/pools/{poolid}` | Cancel a decommission operation on a pool |
| POST | `/rustfs/admin/v3/rebalance/{rebalanceid}` | Start a rebalance operation |
| DELETE | `/rustfs/admin/v3/{v3id}` | Delete service account |
| GET | `/rustfs/admin/v3/{v3id}` | Export IAM data |
| POST | `/rustfs/admin/v3/{v3id}` | Heal cluster, bucket, or prefix with optional pool and set parameters |
| PUT | `/rustfs/admin/v3/{v3id}` | Create or replace a policy |
| GET | `/rustfs/admin/v3/{v3id}/status` | Get decommission status with optional pool and by-id parameters |
| GET | `/rustfs/admin/v4/cluster/snapshot` | Get cluster snapshot |
| GET | `/rustfs/admin/v4/heal/replacement-recovery` | Monitor drive replacement recovery progress and completion status |
| GET | `/rustfs/admin/v4/runtime/capabilities` | Get runtime capabilities |
| GET | `/rustfs/console/health` | GET /rustfs/console/health |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/rustfs/openapi/rustfs-rustfs-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-post-rustfs-admin-v3-v3-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-post-rustfs-admin-v3-idp-builtin-policy-policyid-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-put-rustfs-admin-v3-v3-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-post-rustfs-admin-v3-rebalance-rebalanceid-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-get-rustfs-admin-v3-oidc-providers-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/rustfs/json-schema/rustfs-get-health-response-schema.json

## Other RustFS APIs (3)

- [RustFS Health API](https://apis.io/apis/rustfs/rustfs-health-api/)
- [RustFS Minio API](https://apis.io/apis/rustfs/rustfs-minio-api/)
- [RustFS RustFS API](https://apis.io/apis/rustfs/rustfs-rustfs-api-api/)

## Tags

Rustfs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/rustfs/rustfs-rustfs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/rustfs/.