Elkxi API Reference
Explore our comprehensive API to integrate and manage distributed systems with powerful, efficient tools.
Getting Started
To access the Elkxi API, authenticate via a token provided in the Authorization header using Bearer token authentication.
Authentication
Authorization: Bearer YOUR_API_KEY
You can find your API key in your Elkxi dashboard under Account Settings > API Keys.
API Endpoints
Below are the key endpoints available for interacting with the Elkxi API:
GET /clusters
List all clusters managed by your account.
Response Example:
[
{
"id": "cluster-001",
"name": "Production Cluster",
"status": "active",
"created_at": "2025-03-15T12:32:12Z",
"region": "us-west-2",
"node_count": 8
}
]
Requires Bearer authentication.
POST /clusters
Create a new cluster with custom configurations.
Request Body Example:
{
"name": "staging-cluster",
"region": "us-east-1",
"size": "medium"
}
Response Example:
{
"id": "cluster-002",
"status": "created",
"message": "Cluster 'staging-cluster' successfully created."
}
Requires Bearer authentication and valid JSON body.
Need more help with API Integration?
Visit our API playground or join our developer community for hands-on support.