eEKAS REST API Reference
The complete eEKAS REST API reference describes endpoints, parameters, curl examples and HTTP responses for automating your installation.
Download the complete reference
Download the eEKAS REST API reference (HTML). Open the downloaded file in a browser and use its contents list or browser search.
Edition: 8 October 2026 · Reference version: 1.0.0 · Scope: 285 operations. The curl examples validate certificates. For a private CA, add --cacert /path/to/ca.pem.
Download the complete API documentation package (ZIP): reference, S3 workflows, Customers and Billing guide, and OpenAPI JSON and YAML. Extract all files together and open eekas.html. The S3 workflows describe request bodies and confirmations for backup and recovery.
For setup and your first query, read REST API – Getting Started and Automation.
Coverage
- Common API operations, users and system
- Cluster, Ceph, shares and storage administration
- iSCSI, Fibre Channel, NVMe and initiators
- S3 services, object storage, replication, backup and recovery
- S3 customers, usage and billing
Reference for your installed version
Check available operations against your installation's OpenAPI specification. When API documentation is enabled, the configured API endpoint provides /api/docs for Swagger UI and /api/openapi.json or /api/openapi.yaml for OpenAPI. Access requires a valid API key. The default base URL is https://<server>:18443.
The downloadable reference is a versioned snapshot. Your installation's features and parameters may differ. This administrative REST API is separate from the S3 protocol used to access objects.
Usage and support
API usage is at your own responsibility and is not covered by support. Test changes in a test environment first and follow the operational prerequisites in the user guide.