Elk API

The Elk API allows developers to interact with our deployment platform programmatically. Create, manage, and monitor applications with a developer-first REST API.

📘 API Reference 🧑‍💻 Tutorials

Getting Started

1. Authentication

All API requests require a valid bearer token. You can find your API key in the Elk dashboard under Settings → API Keys.

Authorization: Bearer YOUR_API_KEY

2. Install Client

Use our CLI tool to interact with the API from your terminal:

npm install -g @elk/cli

API Overview

Endpoints

POST /api/v1/deployments
GET /api/v1/status
DELETE /api/v1/logs

Authentication

Bearer Token OAuth 2.0 (in development)

All endpoints require authentication via the Authorization header.

Error Responses

200 - Success
400 - Invalid request
401 - Unauthorized

Example Request

Create Deployment

POST /api/v1/deployments Application/json

{
  "repository": "github.com/your/repo",
  "branch": "main",
  "environment": "staging"
}

Response

{
  "deployment_id": "abc123",
  "status": "queued",
  "timestamp": "2025-04-05T14:30:00Z"
}

Guides

15 min read

Setting Up Webhooks

Learn how to receive real-time notifications for deployment status changes and application events.

5 min read

Using CLI with API

Automate deployment workflows using our powerful command-line interface with API integration.

Security Best Practices

Token Security

• Store API keys in secure environment variables
• Rotate credentials regularly
• Use scoped tokens with least privilege

Rate Limiting

We limit API requests to 100 per minute. Use exponential backoff on failures.

100 requests/min Exponential backoff

Ready to Build?

Explore the full Elk API reference and create an account to start deploying your applications.

API Reference Create Account