🚀NEW: 8 AI-Powered Features Now Available! Learn More →

API Reference

v1.0

Complete REST API documentation for DevControl. Build powerful integrations with your existing tools and workflows.

Get API KeyAuthenticationEndpoints

Fast & Reliable

99.9% uptime SLA with response times under 100ms

Secure by Default

API keys with granular permissions and audit logging

RESTful Design

Intuitive endpoints following REST best practices

Base URL
https://api.getdevcontrol.com

All API requests should be made to this base URL. Append the endpoint path to construct the full URL.

Authentication

API Key Authentication
All API requests require authentication using a Bearer token in the Authorization header.
curl -X GET https://api.getdevcontrol.com/v1/services \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Best Practices

  • • Store API keys securely (environment variables)
  • • Rotate keys regularly (every 90 days)
  • • Use different keys per environment

Important

  • • Never commit keys to version control
  • • Don't expose keys in client-side code
  • • Revoke compromised keys immediately
Manage API KeysSecurity Guide
Rate Limiting
API requests are rate limited to ensure service quality for all users.
1,000
requests/hour
Free Plan
10,000
requests/hour
Pro Plan
100,000
requests/hour
Enterprise

Rate Limit Headers

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1642348800

API Endpoints

4 methods
Services API
Create, update, and manage services in your catalog
/v1/services
GETPOSTPUTDELETE
2 methods
Deployments API
Track and record deployment events
/v1/deployments
GETPOST
2 methods
Infrastructure API
Query and manage AWS resources
/v1/resources
GETPUT
4 methods
Teams API
Manage teams and memberships
/v1/teams
GETPOSTPUTDELETE
1 methods
Metrics API
Access DORA metrics and performance data
/v1/metrics
GET
4 methods
Webhooks API
Configure webhooks for event notifications
/v1/webhooks
GETPOSTPUTDELETE

Example: Create a Service

POSTRequest Body
Create a new service in your catalog
{
  "name": "payment-service",
  "description": "Handles payment processing",
  "tier": "critical",
  "owner": "platform-team",
  "repository": "https://github.com/org/payment-service",
  "tags": {
    "environment": "production",
    "language": "nodejs"
  }
}
200Response
Successful service creation response
{
  "id": "svc_1a2b3c4d",
  "name": "payment-service",
  "description": "Handles payment processing",
  "tier": "critical",
  "owner": "platform-team",
  "repository": "https://github.com/org/payment-service",
  "tags": {
    "environment": "production",
    "language": "nodejs"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Error Handling

HTTP Status Codes
The API uses conventional HTTP status codes to indicate success or failure
200
OK
Request succeeded
201
Created
Resource created successfully
400
Bad Request
Invalid request parameters
401
Unauthorized
Missing or invalid API key
403
Forbidden
Insufficient permissions
404
Not Found
Resource doesn't exist
429
Too Many Requests
Rate limit exceeded
500
Internal Server Error
Server-side error occurred
Error Response Format
All errors return a consistent JSON structure
{
  "error": {
    "code": "validation_error",
    "message": "Invalid request parameters",
    "details": {
      "name": "Service name is required"
    }
  }
}

Webhooks

Event Notifications
Receive real-time notifications when events occur in your DevControl account

Available Events

deployment.completed
deployment.failed
service.created
service.updated
alert.triggered
cost.threshold_exceeded
security.issue_detected
resource.discovered

Webhook Payload Example

{
  "event": "deployment.completed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "deployment_id": "dep_5f6g7h8i",
    "service": "payment-service",
    "environment": "production",
    "status": "success",
    "duration_seconds": 120
  }
}
Configure Webhooks

SDKs & Libraries

Node.js SDK
Official JavaScript/TypeScript library
npm install @devcontrol/sdkView Docs(coming soon)
Python SDK
Official Python client library
pip install devcontrolView Docs(coming soon)
CLI Tool
Command-line interface for DevControl
npm install -g @devcontrol/cliView Docs

Frequently Asked Questions

Need Help with Integration?

Our team is here to help you build powerful integrations. Get in touch for technical support, custom solutions, or partnership opportunities.

Contact API SupportBrowse Documentation