Logo

Command Palette

Search for a command to run...

GET/stacks/:stack_id/alerts/:alert_name
Get Stack Alertpublic

Optional Parameters

stack_id
Stack UID
alert_name
Alert name (e.g., "deployment_success", "server_down")

Returns comprehensive details about the specified stack alert configuration.

Retrieves the alert settings including notification channels, thresholds, and current status for the specified alert type on the stack.

Related Models:StackAlert

Common Alert Names:

  • deployment_success: Deployment completed successfully
  • deployment_failure: Deployment failed
  • server_down: Server became unavailable
  • server_up: Server became available
  • scaling_complete: Auto-scaling operation completed
  • backup_complete: Backup operation completed
Response Status Codes
Status CodeDescription
200Success - Returns alert configuration details
400Bad Request - Invalid alert name
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `public` scope
404Not Found - Stack not found

Request

GET
/stacks/:stack_id/alerts/:alert_name
curl -X GET \
  "https://app.cloud66.com/api/3/stacks/:stack_id/alerts/:alert_name" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": {
    "name": "deployment_success",
    "description": "Notifies when a deployment completes successfully",
    "channels": [
      {
        "type": "email",
        "enabled": true,
        "recipients": [
          "admin@example.com"
        ]
      },
      {
        "type": "slack",
        "enabled": true,
        "webhook_url": "https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK"
      }
    ],
    "active": true,
    "settings": {
      "frequency": "immediate",
      "threshold": 1
    }
  }
}
GET/stacks/:stack_id/alerts
List Stack Alertspublic

Optional Parameters

stack_id
Stack UID

Returns a collection of alert configurations for the specified stack.

Stack alerts provide notification capabilities for various stack events including deployments, server status changes, and system health monitoring. Each alert can be configured with multiple notification channels.

Related Models:StackAlert

Available Alert Types:

  • deployment_success: Deployment completed successfully
  • deployment_failure: Deployment failed
  • server_down: Server became unavailable
  • server_up: Server became available
  • scaling_complete: Auto-scaling operation completed
  • backup_complete: Backup operation completed
Response Status Codes
Status CodeDescription
200Success - Returns list of stack alert configurations
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `public` scope
404Not Found - Stack not found

Request

GET
/stacks/:stack_id/alerts
curl -X GET \
  "https://app.cloud66.com/api/3/stacks/:stack_id/alerts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": [
    {
      "name": "deployment_success",
      "description": "Notifies when a deployment completes successfully",
      "channels": [
        {
          "type": "email",
          "enabled": true,
          "recipients": [
            "admin@example.com"
          ]
        },
        {
          "type": "slack",
          "enabled": true,
          "webhook_url": "https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK"
        }
      ],
      "active": true
    },
    {
      "name": "server_down",
      "description": "Notifies when a server goes down",
      "channels": [
        {
          "type": "email",
          "enabled": true,
          "recipients": [
            "ops@example.com",
            "admin@example.com"
          ]
        }
      ],
      "active": true
    }
  ]
}
PUT/stacks/:stack_id/alerts
Update Stack Alertsadmin

Optional Parameters

stack_id
Stack UID
alerts
Alert configurations to update, keyed by alert name

Updates multiple stack alert configurations in a single operation.

Modifies notification settings for specified alerts on the stack. Validates changes against business rules and permissions before applying updates.

Related Models:StackAlert

Configurable Alert Types:

  • deployment_success: Deployment completed successfully
  • deployment_failure: Deployment failed
  • server_down: Server became unavailable
  • server_up: Server became available
  • scaling_complete: Auto-scaling operation completed
  • backup_complete: Backup operation completed

Channel Configuration:

  • email: Recipients list with email addresses
  • slack: Webhook URL for Slack integration
  • webhook: Custom webhook endpoints
  • sms: SMS notification settings
Response Status Codes
Status CodeDescription
200Success - Alerts updated successfully
400Bad Request - Invalid alert configuration or parameters
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `admin` scope
422Unprocessable Entity - Validation errors in alert settings

Request

PUT
/stacks/:stack_id/alerts
curl -X PUT \
  "https://app.cloud66.com/api/3/stacks/:stack_id/alerts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": {
    "ok": true,
    "message": "Alerts updated successfully"
  }
}