Get database metrics for the last hour (default)

​

Utility Resources (Terminals, Bucket Explorers, DB Monitors)

• terminal — connect to instances via SSH/WebSocket
• bucket_explorer — browse S3 buckets or static websites
• db_monitor — attach metadata for DB health/metrics dashboards

​

Create

• POST /api/:projectSlug/:environmentSlug/terminals
• POST /api/:projectSlug/:environmentSlug/bucket-explorers
• POST /api/:projectSlug/:environmentSlug/db-monitors

• name (string, required)
• positionX, positionY (optional canvas coords)
• metadata (optional JSON; used by db_monitors for config, by bucket_explorers for bucket info)

• name is the S3 bucket name (must follow AWS rules, globally unique). Region optional; will auto-detect when importing existing buckets.

​

List

• GET /api/:projectSlug/:environmentSlug/terminals
• GET /api/:projectSlug/:environmentSlug/bucket-explorers
• GET /api/:projectSlug/:environmentSlug/db-monitors

​

Get one

• GET /api/:projectSlug/:environmentSlug/terminals/:terminalId
• GET /api/:projectSlug/:environmentSlug/bucket-explorers/:bucketExplorerId
• GET /api/:projectSlug/:environmentSlug/db-monitors/:monitorId

​

Update

• PATCH /api/:projectSlug/:environmentSlug/terminals/:terminalId
• PATCH /api/:projectSlug/:environmentSlug/bucket-explorers/:bucketExplorerId
• PATCH /api/:projectSlug/:environmentSlug/db-monitors/:monitorId

​

Delete

• DELETE /api/:projectSlug/:environmentSlug/resources/:resourceId

​

DB Monitor Pulse/Metrics

• GET /api/:projectSlug/:environmentSlug/db-monitors/:monitorId/pulse - Get database metrics using DB monitor (CPU, connections, memory, storage, I/O, network)

• Fetches real-time and historical metrics from AWS CloudWatch for the connected database
• Automatically resolves the connected database from the resource connection between the DB monitor and database
• Returns CPU utilization, database connections, memory, storage, read/write latency, IOPS, and network throughput
• Supports custom time ranges and aggregation periods
• Note: The DB monitor must be connected to a database via resource connections for this endpoint to work

• monitorId - DB monitor database ID

• startTime (optional): ISO 8601 timestamp for start time (default: 1 hour ago)
• endTime (optional): ISO 8601 timestamp for end time (default: now)
• period (optional): Period in seconds for metric aggregation (default: 300 = 5 minutes, minimum: 60)

# Get database metrics for the last hour (default)
curl "https://api.gateways.app/api/codepanel/master/db-monitors/1/pulse" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Get database metrics for a custom time range
curl "https://api.gateways.app/api/codepanel/master/db-monitors/1/pulse?startTime=2024-01-15T10:00:00Z&endTime=2024-01-15T11:00:00Z&period=60" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "message": "Database metrics retrieved successfully",
  "data": {
    "dbMonitorId": 1,
    "databaseId": 5,
    "resourceId": "production-db-codepanel-master",
    "region": "us-east-1",
    "metrics": {
      "cpu": 18.7,
      "ram": 2147483648,
      "connections": 30
    }
  }
}

• Values are the most recent (latest) single data point from CloudWatch
• cpu: CPU utilization percentage (0-100)
• ram: Freeable memory in bytes
• connections: Number of active database connections
• If a metric has no data available, it will be null

{
  "error": "Database connection not found",
  "message": "This DB monitor is not connected to any database. Please connect it to a database first."
}

​

Positions

• PATCH /api/:projectSlug/:environmentSlug/resources/:resourceId/position (use resource’s database ID)

​

Resources listing

• GET /api/:projectSlug/:environmentSlug/resources (project/environment scope; filter with type=db_monitors, type=bucket_explorers, or type=terminals)
• Resource detail: GET /api/:projectSlug/:environmentSlug/resources/:resourceId (use resource’s database ID)