2. Endpoint Summary
Every endpoint in this guide, one row each, grouped and ordered the same way as Chapters 3 through 14 below. Each path links directly to that endpoint’s full reference.
Chapter 3. Authentication
| Path | Summary | Method |
|---|---|---|
/api/v1/auth/change-password |
Change own password | POST |
/api/v1/auth/login |
Login | POST |
/api/v1/auth/me |
Current user identity | GET |
/api/v1/auth/refresh |
Refresh tokens | POST |
/api/v1/auth/tenant-switch |
Switch into a tenant (Platform Admin only) | POST |
/api/v1/auth/tokens |
List your API tokens | GET |
/api/v1/auth/tokens |
Issue an API token | POST |
/api/v1/auth/tokens/{token_id} |
Read one of your API tokens | GET |
/api/v1/auth/tokens/{token_id} |
Revoke an API token | DELETE |
Chapter 4. Realm and Platform
| Path | Summary | Method |
|---|---|---|
/api/v1/about |
About | GET |
/api/v1/realm |
Get realm | GET |
/api/v1/realm/actions |
Perform realm action | POST |
Chapter 5. Tenants
| Path | Summary | Method |
|---|---|---|
/api/v1/tenants |
List tenants | GET |
/api/v1/tenants |
Create tenant | POST |
/api/v1/tenants/archived |
List archived tenants | GET |
/api/v1/tenants/roles |
List roles available on the current tenant | GET |
/api/v1/tenants/{tenant_id} |
Get tenant info | GET |
/api/v1/tenants/{tenant_id} |
Update tenant | PATCH |
/api/v1/tenants/{tenant_id} |
Delete tenant | DELETE |
/api/v1/tenants/{tenant_id}/storagesets |
List tenant storageset quota allocations | GET |
/api/v1/tenants/{tenant_id}/storagesets/{storageset_id} |
Get tenant storageset | GET |
/api/v1/tenants/{tenant_id}/storagesets/{storageset_id} |
Assign or resize tenant storageset | PUT |
/api/v1/tenants/{tenant_id}/storagesets/{storageset_id} |
Unassign tenant storageset | DELETE |
Chapter 6. Tenant Users and Roles
| Path | Summary | Method |
|---|---|---|
/api/v1/tenants/{tenant_id}/users |
List tenant users | GET |
/api/v1/tenants/{tenant_id}/users |
Create tenant user | POST |
/api/v1/tenants/{tenant_id}/users/{user_id} |
Get tenant user | GET |
/api/v1/tenants/{tenant_id}/users/{user_id} |
Update tenant user | PATCH |
/api/v1/tenants/{tenant_id}/users/{user_id} |
Delete tenant user | DELETE |
/api/v1/tenants/{tenant_id}/users/{user_id}/roles |
List tenant user roles | GET |
/api/v1/tenants/{tenant_id}/users/{user_id}/roles |
Set tenant user roles | PATCH |
Chapter 7. PanFS Users
| Path | Summary | Method |
|---|---|---|
/api/v1/tenants/{tenant_id}/fs-users |
List PanFS users | GET |
/api/v1/tenants/{tenant_id}/fs-users |
Create PanFS user | POST |
/api/v1/tenants/{tenant_id}/fs-users/{fs_user_id} |
Get PanFS user | GET |
/api/v1/tenants/{tenant_id}/fs-users/{fs_user_id} |
Update PanFS user | PATCH |
/api/v1/tenants/{tenant_id}/fs-users/{fs_user_id} |
Delete PanFS user | DELETE |
/api/v1/tenants/{tenant_id}/fs-users/{fs_user_id}/s3/secret |
Reveal a PanFS user S3 secret | GET |
/api/v1/tenants/{tenant_id}/fs-users/{fs_user_id}/s3/secret/rotate |
Rotate a PanFS user S3 secret | POST |
Chapter 8. Service Accounts
| Path | Summary | Method |
|---|---|---|
/api/v1/service-accounts |
List service accounts | GET |
/api/v1/service-accounts |
Create a service account | POST |
/api/v1/service-accounts/{service_account_id} |
Get a service account | GET |
/api/v1/service-accounts/{service_account_id} |
Update a service account | PATCH |
/api/v1/service-accounts/{service_account_id} |
Delete a service account | DELETE |
/api/v1/service-accounts/{service_account_id}/roles |
List service account roles | GET |
/api/v1/service-accounts/{service_account_id}/roles |
Set service account roles | PATCH |
/api/v1/service-accounts/{service_account_id}/tokens |
List service account keys | GET |
/api/v1/service-accounts/{service_account_id}/tokens |
Issue a service account key | POST |
/api/v1/service-accounts/{service_account_id}/tokens/{token_id} |
Revoke a service account key | DELETE |
Chapter 9. Volumes
| Path | Summary | Method |
|---|---|---|
/api/v1/volumes |
List volumes | GET |
/api/v1/volumes |
Create a new volume | POST |
/api/v1/volumes/{volume_id} |
Get volume info | GET |
/api/v1/volumes/{volume_id} |
Update volume | PATCH |
/api/v1/volumes/{volume_id} |
Delete volume | DELETE |
/api/v1/volumes/{volume_id}/actions |
Perform action on volume | POST |
/api/v1/volumes/{volume_id}/space |
Get volume space | GET |
Chapter 10. StorageSets
| Path | Summary | Method |
|---|---|---|
/api/v1/storagesets |
List storagesets | GET |
/api/v1/storagesets |
Create StorageSet | POST |
/api/v1/storagesets/{storageset_id} |
Get StorageSet details | GET |
/api/v1/storagesets/{storageset_id} |
Update StorageSet | PATCH |
/api/v1/storagesets/{storageset_id} |
Delete StorageSet | DELETE |
/api/v1/storagesets/{storageset_id}/actions |
Perform StorageSet Action | POST |
/api/v1/storagesets/{storageset_id}/space |
Get StorageSet space | GET |
Chapter 11. Subnets and Attachments
Chapter 12. Nodes and Hardware
| Path | Summary | Method |
|---|---|---|
/api/v1/nodes |
List nodes | GET |
/api/v1/nodes/{dataserial} |
Get node info | GET |
/api/v1/nodes/{dataserial}/actions |
Perform action on node | POST |
/api/v1/nodes/{dataserial}/drain |
Get OSD drain status | GET |
/api/v1/nodes/{dataserial}/drain |
Start or stop OSD drain | POST |
/api/v1/hardware |
List hardware models | GET |
/api/v1/hardware/{dataserial}/actions |
Perform an action on a hardware component | POST |
/api/v1/hardware/{model_id} |
Get hardware model info | GET |
Chapter 13. S3 Gateway
| Path | Summary | Method |
|---|---|---|
/api/v1/tenants/{tenant_id}/s3 |
Get S3 config | GET |
/api/v1/tenants/{tenant_id}/s3 |
Create S3 config | PUT |
/api/v1/tenants/{tenant_id}/s3 |
Update S3 config | PATCH |
/api/v1/tenants/{tenant_id}/s3 |
Delete S3 config | DELETE |
/api/v1/tenants/{tenant_id}/s3/tls/renew |
Renew the realm-generated S3 edge cert | POST |
/api/v1/s3/enabled |
Get realm-wide S3 enable flag | GET |
/api/v1/s3/enabled |
Set realm-wide S3 enable flag | PUT |
/api/v1/s3/prefix |
Get realm-wide S3 prefix path | GET |
/api/v1/s3/prefix |
Set realm-wide S3 prefix path | PUT |
/api/v1/tenants/{tenant_id}/s3/buckets |
List S3 buckets | GET |
/api/v1/tenants/{tenant_id}/s3/buckets |
Create S3 bucket | POST |
/api/v1/tenants/{tenant_id}/s3/buckets/{name} |
Delete S3 bucket | DELETE |
/api/v1/tenants/{tenant_id}/s3-credentials/{access_key}/reveal |
Resolve an S3 access key to the identity behind it | POST |
/api/v1/tenants/{tenant_id}/s3/instances |
List a tenant’s S3 gateway instances | GET |
/api/v1/tenants/{tenant_id}/s3/instances |
Create an S3 gateway instance | POST |
/api/v1/tenants/{tenant_id}/s3/instances/delete-all |
Delete every instance of the tenant and wait for teardown | POST |
/api/v1/tenants/{tenant_id}/s3/instances/start-all |
Start every instance of the tenant | POST |
/api/v1/tenants/{tenant_id}/s3/instances/stop-all |
Stop every instance of the tenant | POST |
/api/v1/tenants/{tenant_id}/s3/instances/{iid} |
Show an S3 gateway instance (bare-iid fan-out or specific node) | GET |
/api/v1/tenants/{tenant_id}/s3/instances/{iid} |
Delete an S3 gateway instance (fan-out if node omitted; requires confirm) | DELETE |
/api/v1/tenants/{tenant_id}/s3/instances/{iid}/start |
Start an S3 gateway instance (fan-out if node omitted) | POST |
/api/v1/tenants/{tenant_id}/s3/instances/{iid}/stop |
Stop an S3 gateway instance (fan-out if node omitted) | POST |
Chapter 14. Observability
| Path | Summary | Method |
|---|---|---|
/api/v1/observability/alerts |
Alerts snapshot (keyed set) | GET |
/api/v1/observability/alerts/stream |
Alerts SSE stream (added/resolved) | GET |
/api/v1/observability/audit |
Audit trail snapshot (last N) | GET |
/api/v1/observability/audit/stream |
Audit SSE stream (append deltas) | GET |
/api/v1/observability/audit/{request_id} |
Audit record with failure diagnostics | GET |
/api/v1/observability/events |
PanFS events snapshot (last N) | GET |
/api/v1/observability/events/stream |
PanFS events SSE stream (append deltas) | GET |
/api/v1/observability/logs |
Logs snapshot (last N) | GET |
/api/v1/observability/logs/stream |
Logs SSE stream (append deltas) | GET |
/api/v1/observability/logs/{logsql_endpoint} |
VictoriaLogs /select/logsql proxy | GET |
/api/v1/observability/metrics/query |
Prometheus instant query proxy | GET |
/api/v1/observability/metrics/query_range |
Prometheus range query proxy | GET |
/api/v1/observability/metrics/stream |
Grouped metric SSE stream (append deltas for several keys) | GET |
/api/v1/observability/metrics/targets |
List metrics targets | GET |
/api/v1/observability/metrics/{key} |
Metric snapshot (range window) | GET |
/api/v1/observability/metrics/{key}/stream |
Metric SSE stream (append deltas) | GET |
/api/v1/observability/storagesets/status |
Storage-set alert status | GET |