$ API Reference

Complete reference documentation for the DevForge REST API. Build powerful integrations with our developer platform.

Base URL
https://api.devforge.dev/v1
HTTPS Required

All API requests must use HTTPS encryption.

JSON Format

Request and response bodies are JSON encoded.

Authentication

DevForge uses API keys to authenticate requests. Include your API key in the Authorization header with every request.

Authorization Header
Authorization: Bearer df_live_xxxxxxxxxxxxxxxxxxxx
Keep your API key secure

Never expose your API key in client-side code or public repositories. Use environment variables to store keys securely.

Rate Limiting

API requests are rate limited to ensure fair usage. Rate limits vary by plan:

Plan Rate Limit Burst
Free 100 req/min 150 req
Pro 1,000 req/min 1,500 req
Enterprise Unlimited Custom

Projects

Projects are the top-level resource in DevForge. Each project can contain multiple deployments, API keys, and configurations.

GET /projects List all projects

Query Parameters

limit integer - Number of results (default: 20, max: 100)
offset integer - Pagination offset

Response

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "My API Project",
      "created_at": "2026-01-15T10:00:00Z",
      "status": "active"
    }
  ],
  "meta": {
    "total": 42,
    "limit": 20,
    "offset": 0
  }
}
POST /projects Create a project

Request Body

{
  "name": "My New Project",
  "description": "A new API project",
  "environment": "production"
}

Response

{
  "id": "proj_xyz789",
  "name": "My New Project",
  "description": "A new API project",
  "created_at": "2026-01-15T10:00:00Z",
  "status": "active"
}
DELETE /projects/:id Delete a project

Path Parameters

id string - The project ID to delete

Error Handling

DevForge uses conventional HTTP response codes to indicate success or failure. Codes in the 2xx range indicate success, 4xx indicate client errors, and 5xx indicate server errors.

200 OK - Request succeeded
201 Created - Resource created successfully
400 Bad Request - Invalid request parameters
401 Unauthorized - Missing or invalid API key
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Something went wrong

Ready to build?

Get your API key and start integrating with DevForge today.

Get Your API Key