SwiftStack Controller API Documentation

API functionality is available on both SwiftStack Controller As-a-Service and SwiftStack Controller On-Premises installations.

General Information

In addition to any method-specific parameters specified in their respective sections, all API commands take the following parameters:

• Authorization
• Format
• Pagination
• Filtering
• Discovery

Commands

• Cluster
  • List Clusters
  • View Cluster Details
  • View Cluster Disk Capacity
• Utilization
  • Types of Utilization Data
    • Storage Data
    • Transfer Data
  • Time Ranges
  • Correctness
  • Per-Account Storage Utilization
  • Per-Account Transfer Utilization
  • Per-Cluster Total Storage Utilization
  • Per-Cluster Total Transfer Utilization
  • Single-Account Storage Utilization
  • Single-Account Transfer Utilization
  • Single-Account Storage Utilization Details
  • Single-Account Transfer Utilization Details
  • Troubleshooting
• User
  • List Users
  • Create User
  • View User Details
  • Change User Details
  • Delete User
• User Database Deployment Job
  • Create User Database Deployment Job
  • View User Database Deployment Details
  • List User Database Deployment Jobs
• Node
  • List Nodes
  • Enable/Disable Nodes
  • View Node Details
  • Enable/Disable Node
• Devices
  • List Devices
  • View Device Details
• Gateway Share
  • List NFS Shares
  • List CIFS Shares
  • Create NFS Share
  • Create CIFS Share
  • View Share Details
  • Change Share Details
  • Delete Share
• Gateway Deployments
  • Create Gateway Deployment Job
  • View Gateway Deployment Details
  • List Gateway Deployment Jobs
• Cluster Metrics
  • List Cluster Metrics
  • Cluster Metric Polling
• Node Metrics
  • List Node Metrics
  • Node Metric Polling