API Reference

Complete documentation for the DevTools Pro API. Base URL: https://api.devtools.io/v1

Quick Start

// Installation

$ npm install -g @devtools/cli

// Authentication

$ devtools auth login

// Make Your First Request

const response = await fetch('https://api.devtools.io/v1/status', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data); // { status: 'ok', version: '3.0.0' }

Authentication

The DevTools Pro API uses Bearer token authentication. Include your API key in the Authorization header of every request.

Authorization: Bearer dt_live_xxxxxxxxxxxxxxxxxxxx

You can generate API keys from the DevTools dashboard or using the CLI:

$ devtools keys create --name "My App" --scope read,write

API Endpoints

GET /v1/status

Description

Returns the current API status and version information.

Response

{
  "status": "ok",
  "version": "3.0.0",
  "timestamp": "2026-04-07T15:42:00Z"
}
GET /v1/projects

Description

List all projects in your account.

Parameters

Name Type Description
limit integer Maximum number of results (default: 20, max: 100)
offset integer Pagination offset

Response

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "my-project",
      "region": "us-east",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 42
}
POST /v1/deployments

Description

Create a new deployment to your project.

Request Body

{
  "project_id": "proj_abc123",
  "environment": "production",
  "regions": ["us-east", "eu-west"],
  "version": "v1.2.3"
}
Name Type Required Description
project_id string yes Project identifier
environment string yes Target environment (staging/production)
regions array no Deployment regions (default: all)
DELETE /v1/projects/:id

Description

Delete a project and all associated data. This action cannot be undone.

Response

{
  "success": true,
  "message": "Project deleted successfully"
}

Error Handling

The API returns standard HTTP status codes and a JSON error body:

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired",
    "status": 401
  }
}

Common Error Codes

Code Status Description
INVALID_API_KEY 401 API key is missing or invalid
RATE_LIMIT_EXCEEDED 429 Too many requests, slow down
VALIDATION_ERROR 400 Invalid request parameters
NOT_FOUND 404 Resource does not exist
INTERNAL_ERROR 500 Server error, contact support

SDKs

Official SDKs are available for all major languages:

# Node.js
npm install @devtools/sdk

# Python
pip install devtools-sdk

# Go
go get github.com/devtools/sdk-go

# Ruby
gem install devtools_sdk

CLI Reference

# Authenticate
devtools auth login

# Initialize project
devtools init [project-name]

# Deploy
devtools deploy --env [environment]

# View logs
devtools logs --follow

# Manage API keys
devtools keys list
devtools keys create --name "My App"
devtools keys revoke [key-id]

# Check status
devtools status