Dashboard API Documentation

Base URL

http://localhost:4000/api/dashboard

Authentication

All endpoints require authentication using one of the following methods:

API Key

X-API-Key: algo_sk_your_api_key_here

Personal Access Token

Authorization: Bearer pat_your_token_here

Project Management API

Get Projects with Stats

GET /projects/projects

Query Parameters:

search (optional): Search query for project name/description
language (optional): Filter by programming language
favorite (optional): Set to "true" to show only favorites

Response:

{
  "projects": [
    {
      "id": 1,
      "name": "E-commerce Platform",
      "description": "Full-stack online store",
      "language": "TypeScript",
      "deploymentStatus": "running",
      "lastAccessedAt": "2024-03-15T10:30:00Z",
      "isFavorite": true,
      "resourceUsage": {
        "cpu": 45,
        "memory": 512,
        "storage": 1024
      }
    }
  ]
}

Get Project Templates

GET /projects/templates

Query Parameters:

category (optional): Filter by template category

Response:

{
  "templates": [
    {
      "id": 1,
      "name": "Next.js Starter",
      "language": "TypeScript",
      "framework": "Next.js",
      "category": "web"
    }
  ]
}

Create Project from Template

POST /projects/projects/from-template

Request Body:

{
  "templateId": 1,
  "projectName": "My New Project"
}

Response:

{
  "project": {
    "id": 123,
    "name": "My New Project",
    "language": "TypeScript",
    "framework": "Next.js"
  }
}

Toggle Project Favorite

POST /projects/projects/:projectId/favorite

Response:

{
  "isFavorite": true
}

Share Project

POST /projects/projects/:projectId/share

Request Body:

{
  "email": "[email protected]",
  "role": "editor"
}

Roles: viewer, editor, admin

Response:

{
  "collaborator": {
    "id": 1,
    "userId": 456,
    "role": "editor",
    "status": "pending"
  }
}

Get Project Collaborators

GET /projects/projects/:projectId/collaborators

Response:

{
  "collaborators": [
    {
      "id": 1,
      "userId": 456,
      "email": "[email protected]",
      "name": "John Doe",
      "role": "editor",
      "status": "accepted"
    }
  ]
}

Accept Collaboration Invite

POST /projects/projects/:projectId/accept-invite

Response:

{
  "message": "Invitation accepted"
}

Transfer Project

POST /projects/projects/:projectId/transfer

Request Body:

{
  "newOwnerEmail": "[email protected]"
}

Resource Monitoring API

Get Current Usage

GET /resources/usage/current

Response:

{
  "usage": {
    "cpu": {
      "current": 45,
      "limit": 100,
      "percentage": 45,
      "unit": "%"
    },
    "memory": {
      "current": 1536,
      "limit": 2048,
      "percentage": 75,
      "unit": "MB"
    },
    "storage": {
      "current": 3584,
      "limit": 10240,
      "percentage": 35,
      "unit": "MB"
    },
    "bandwidth": {
      "current": 25600,
      "limit": 102400,
      "unit": "MB"
    }
  }
}

Get Historical Usage

GET /resources/usage/historical

Query Parameters:

metric (required): Metric type (cpu, memory, storage, bandwidth)
start (required): Start date (ISO 8601)
end (required): End date (ISO 8601)

Response:

{
  "metrics": [
    {
      "id": 1,
      "metricType": "cpu",
      "value": 45,
      "unit": "%",
      "timestamp": "2024-03-15T10:00:00Z"
    }
  ]
}

Get Usage Time Series

GET /resources/usage/timeseries

Query Parameters:

metric (required): Metric type
hours (optional): Number of hours to fetch (default: 24)

Response:

{
  "timeSeries": [
    {
      "timestamp": "2024-03-15T10:00:00Z",
      "value": 45
    }
  ]
}

Record Metric

POST /resources/usage/record

Request Body:

{
  "projectId": 123,
  "metricType": "cpu",
  "value": 45,
  "unit": "%"
}

Get Billing Breakdown

GET /resources/billing/current

Response:

{
  "billing": {
    "id": 1,
    "periodStart": "2024-03-01",
    "periodEnd": "2024-03-31",
    "totalCost": 45.67,
    "cpuCost": 12.34,
    "memoryCost": 15.89,
    "storageCost": 8.44,
    "bandwidthCost": 9.0,
    "status": "pending"
  }
}

Get Usage Forecast

GET /resources/usage/forecast

Query Parameters:

metric (required): Metric type

Response:

{
  "forecast": {
    "metricType": "cpu",
    "currentValue": 45,
    "forecastedValue": 52,
    "forecastDate": "2024-04-15T00:00:00Z",
    "confidence": 0.85,
    "trend": "increasing"
  }
}

Create Resource Alert

POST /resources/alerts

Request Body:

{
  "metricType": "memory",
  "thresholdValue": 1800,
  "thresholdPercentage": 85
}

Get Alerts

GET /resources/alerts

Response:

{
  "alerts": [
    {
      "id": 1,
      "metricType": "memory",
      "thresholdValue": 1800,
      "thresholdPercentage": 85,
      "isActive": true,
      "lastTriggeredAt": "2024-03-15T10:30:00Z"
    }
  ]
}

API Management API

Generate API Key

POST /api/api-keys

Request Body:

{
  "name": "Production API Key",
  "scopes": ["read", "write", "deploy"],
  "expiresAt": "2025-12-31T23:59:59Z"
}

Response:

{
  "apiKey": {
    "id": 1,
    "name": "Production API Key",
    "keyPrefix": "algo_sk_prod",
    "scopes": ["read", "write", "deploy"],
    "key": "algo_sk_prod_abc123..." // Only shown once!
  }
}

List API Keys

GET /api/api-keys

Response:

{
  "apiKeys": [
    {
      "id": 1,
      "name": "Production API Key",
      "keyPrefix": "algo_sk_prod",
      "scopes": ["read", "write", "deploy"],
      "lastUsedAt": "2024-03-15T10:30:00Z",
      "isActive": true
    }
  ]
}

Revoke API Key

POST /api/api-keys/:keyId/revoke

Delete API Key

DELETE /api/api-keys/:keyId

Create Webhook

POST /api/webhooks

Request Body:

{
  "name": "Deploy Notifications",
  "url": "https://hooks.slack.com/services/...",
  "events": ["deployment.success", "deployment.failure"],
  "projectId": 123,
  "isActive": true
}

Response:

{
  "webhook": {
    "id": 1,
    "name": "Deploy Notifications",
    "url": "https://hooks.slack.com/services/...",
    "events": ["deployment.success", "deployment.failure"],
    "secret": "whsec_abc123...",
    "isActive": true
  }
}

List Webhooks

GET /api/webhooks

Query Parameters:

projectId (optional): Filter by project

Update Webhook

PATCH /api/webhooks/:webhookId

Request Body:

{
  "name": "Updated Name",
  "isActive": false
}

Delete Webhook

DELETE /api/webhooks/:webhookId

Get Webhook Deliveries

GET /api/webhooks/:webhookId/deliveries

Query Parameters:

limit (optional): Number of deliveries to fetch (default: 50)

Response:

{
  "deliveries": [
    {
      "id": 1,
      "eventType": "deployment.success",
      "responseStatus": 200,
      "success": true,
      "deliveredAt": "2024-03-15T10:30:00Z"
    }
  ]
}

Get API Usage Analytics

GET /api/analytics/usage

Query Parameters:

start (optional): Start date (ISO 8601)
end (optional): End date (ISO 8601)

Response:

{
  "analytics": {
    "totalRequests": 15243,
    "successRate": 99.2,
    "averageResponseTime": 145,
    "requestsByEndpoint": [
      {
        "endpoint": "/api/projects",
        "count": 5432,
        "averageResponseTime": 98
      }
    ],
    "requestsByStatus": [
      {
        "statusCode": 200,
        "count": 15123
      }
    ],
    "timeline": [
      {
        "date": "2024-03-15",
        "count": 543
      }
    ]
  }
}

Account Settings API

Get Profile

GET /settings/profile

Response:

{
  "profile": {
    "id": 1,
    "email": "[email protected]",
    "name": "John Doe",
    "avatarUrl": "https://...",
    "role": "user"
  }
}

Update Profile

PATCH /settings/profile

Request Body:

{
  "name": "Jane Doe",
  "email": "[email protected]",
  "avatarUrl": "https://..."
}

Create Organization

POST /settings/organizations

Request Body:

{
  "name": "Acme Corp",
  "slug": "acme-corp",
  "description": "Our company organization"
}

List Organizations

GET /settings/organizations

Get Organization Members

GET /settings/organizations/:orgId/members

Invite Organization Member

POST /settings/organizations/:orgId/invite

Request Body:

{
  "email": "[email protected]",
  "role": "admin"
}

Roles: owner, admin, member

Add Payment Method

POST /settings/payment-methods

Request Body:

{
  "type": "card",
  "providerPaymentMethodId": "pm_123456",
  "lastFour": "4242",
  "brand": "Visa",
  "expiresAt": "2025-12-31"
}

List Payment Methods

GET /settings/payment-methods

Set Default Payment Method

POST /settings/payment-methods/:methodId/set-default

Delete Payment Method

DELETE /settings/payment-methods/:methodId

List Invoices

GET /settings/invoices

Response:

{
  "invoices": [
    {
      "id": 1,
      "invoiceNumber": "INV-2024-001",
      "amount": 45.67,
      "currency": "USD",
      "status": "paid",
      "pdfUrl": "https://...",
      "issuedAt": "2024-03-01T00:00:00Z"
    }
  ]
}

Get Invoice

GET /settings/invoices/:invoiceId

Get Notification Preferences

GET /settings/notifications/preferences

Response:

{
  "preferences": {
    "emailNotifications": true,
    "emailDeploymentSuccess": true,
    "emailDeploymentFailure": true,
    "emailResourceAlerts": true,
    "emailBillingUpdates": true,
    "slackNotifications": false,
    "slackWebhookUrl": null
  }
}

Update Notification Preferences

PATCH /settings/notifications/preferences

Request Body:

{
  "emailNotifications": true,
  "slackWebhookUrl": "https://hooks.slack.com/..."
}

Setup 2FA

POST /settings/2fa/setup

Response:

{
  "secret": "base64_secret",
  "backupCodes": ["ABC123", "DEF456", ...]
}

Enable 2FA

POST /settings/2fa/enable

Request Body:

{
  "code": "123456"
}

Disable 2FA

POST /settings/2fa/disable

Get 2FA Status

GET /settings/2fa/status

Response:

{
  "isEnabled": true
}

Add SSH Key

POST /settings/ssh-keys

Request Body:

{
  "name": "Work Laptop",
  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5..."
}

List SSH Keys

GET /settings/ssh-keys

Delete SSH Key

DELETE /settings/ssh-keys/:keyId

Create Personal Access Token

POST /settings/tokens

Request Body:

{
  "name": "CLI Token",
  "scopes": ["read", "write"],
  "expiresAt": "2025-12-31T23:59:59Z"
}

Response:

{
  "token": {
    "id": 1,
    "name": "CLI Token",
    "plainToken": "pat_abc123...", // Only shown once!
    "tokenPrefix": "pat_cli_",
    "scopes": ["read", "write"]
  }
}

List Personal Access Tokens

GET /settings/tokens

Revoke Personal Access Token

POST /settings/tokens/:tokenId/revoke

Delete Personal Access Token

DELETE /settings/tokens/:tokenId

WebSocket Events

Connection

const socket = io('http://localhost:4000');

socket.on('connect', () => {
  console.log('Connected');
});

Resource Updates

// Subscribe to resource updates
socket.emit('subscribe:resources', { projectId: '123' });

// Listen for updates
socket.on('resource:update', (data) => {
  console.log('Resource update:', data);
  // { type: 'cpu', value: 45, timestamp: '...' }
});

// Unsubscribe
socket.emit('unsubscribe:resources', { projectId: '123' });

Notifications

// Subscribe to notifications
socket.emit('subscribe:notifications', { userId: '456' });

// Listen for notifications
socket.on('notification', (data) => {
  console.log('Notification:', data);
  // { id: '...', type: 'success', title: '...', message: '...' }
});

Deployment Status

// Subscribe to deployment status
socket.emit('subscribe:deployment', { projectId: '123' });

// Listen for status updates
socket.on('deployment:status', (data) => {
  console.log('Deployment status:', data);
  // { status: 'deploying', progress: 50, ... }
});

Error Responses

All endpoints return errors in the following format:

{
  "error": "Error message here"
}

Common Status Codes:

400: Bad Request - Invalid parameters
401: Unauthorized - Missing or invalid authentication
403: Forbidden - Insufficient permissions
404: Not Found - Resource doesn't exist
500: Internal Server Error - Server error

Rate Limiting

API requests are rate limited:

1000 requests per hour per API key
100 requests per minute per API key

Rate limit headers:

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

FilesExpand file tree

DASHBOARD_API.md

Latest commit

History

DASHBOARD_API.md

File metadata and controls

Dashboard API Documentation

Base URL

Authentication

API Key

Personal Access Token

Project Management API

Get Projects with Stats

Get Project Templates

Create Project from Template

Toggle Project Favorite

Share Project

Get Project Collaborators

Accept Collaboration Invite

Transfer Project

Resource Monitoring API

Get Current Usage

Get Historical Usage

Get Usage Time Series

Record Metric

Get Billing Breakdown

Get Usage Forecast

Create Resource Alert

Get Alerts

API Management API

Generate API Key

List API Keys

Revoke API Key

Delete API Key

Create Webhook

List Webhooks

Update Webhook

Delete Webhook

Get Webhook Deliveries

Get API Usage Analytics

Account Settings API

Get Profile

Update Profile

Create Organization

List Organizations

Get Organization Members

Invite Organization Member

Add Payment Method

List Payment Methods

Set Default Payment Method

Delete Payment Method

List Invoices

Get Invoice

Get Notification Preferences

Update Notification Preferences

Setup 2FA

Enable 2FA

Disable 2FA

Get 2FA Status

Add SSH Key

List SSH Keys

Delete SSH Key

Create Personal Access Token

List Personal Access Tokens

Revoke Personal Access Token

Delete Personal Access Token

WebSocket Events

Connection

Resource Updates

Notifications

Deployment Status

Error Responses

Rate Limiting