API Overview
On this page, you can learn about:
- API Overview - Understand the Eloq API's capabilities and architecture
- Authentication - Learn how to authenticate and secure your API requests
- Base URL & Endpoints - Access the API base URL and available endpoints
- Request/Response Format - Understand API request and response structures
- Example Usage - See practical examples of API calls with curl commands
- SDK Integration - Links to Python and TypeScript SDKs for easier development
About Eloq API
The Eloq API is a RESTful web service that allows you to programmatically interact with Eloq's cloud infrastructure. Our API follows industry-standard practices and provides secure, scalable access to all Eloq platform features.
- Manage Organizations- Create and configure organizations, manage user roles and permissions
- Deploy Clusters - Launch EloqKV, EloqSQL, and EloqDoc clusters with custom configurations
Eloq API base URL
The base URL is:
https://api-prod.eloqdata.com/api/v1/
Authentication
All API requests require authentication using an API token. You can obtain your API token from the EloqCloud Dashboard.
# Include your API token in the Authorization header
curl -X GET "https://api-prod.eloqdata.com/api/v1/org-info" \
-H "Authorization: {{YOUR_API_KEY}}"
Response Format
The API returns responses in JSON format with standard HTTP status codes:
{
"code": 0,
"data": "string",
"message": "string"
}
API Endpoints Overview
Basic Information
GET /org-info- Get organization informationGET /skus-by-args- Filter available SKUs by type, module, and cloud provider
Cluster Management
POST /orgs/{orgId}/projects/{projectId}/clusters- Create a new clusterGET /orgs/{orgId}/projects/{projectId}/clusters- List clustersGET /orgs/{orgId}/projects/{projectId}/clusters/{clusterName}- Get cluster detailsDELETE /orgs/{orgId}/projects/{projectId}/clusters/{clusterName}/delete- Delete a cluster
See details
Support
Need help? Check out our: Join our Discord Server to ask questions or see what others are doing with Eloq.