# API Reference

Complete reference for the DeployAlly REST API.

# Base URL

# Authentication

The API uses API Key authentication via header:

Authorization: Bearer da_xxx

See Authentication for details on obtaining and managing API keys.

# Format

• Request: JSON (Content-Type: application/json)
• Response: JSON
• Encoding: UTF-8

# Endpoints

# Templates

# Definitions

# Instances

# Servers

# Deployments

# Responses

# Success

{
  "success": true,
  "data": { ... }
}

# List with Pagination

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 100,
    "total_pages": 5
  }
}

# Error

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'name' is required",
    "details": { ... }
  }
}

# Error Codes

# Rate Limits

Response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1699900000

# Examples

# List Templates

curl -X GET "https://sys.deployally.com/api/v1/templates" \
  -H "Authorization: Bearer da_xxx"

# Create Definition

curl -X POST "https://sys.deployally.com/api/v1/definitions" \
  -H "Authorization: Bearer da_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "mysql-8.4",
    "name": "mysql_my_database",
    "params": {
      "database_name": "my_database",
      "user_name": "my_user",
      "user_password": "secure_password"
    },
    "profile": "development"
  }'

# Deploy

curl -X POST "https://sys.deployally.com/api/v1/deployments" \
  -H "Authorization: Bearer da_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "definition_id": "def_abc123",
    "server_id": "srv_xyz789"
  }'

# SDKs

Official SDKs in development:

• Python (coming soon)
• Node.js (coming soon)
• Go (coming soon)

# Next Steps

• Authentication — API Key management
• Endpoints — detailed documentation
• Integration — integration guide