Application alerts

Use these endpoints to read and enable an application's email alerts. Alerts are off by default, apply to application (HTTP) projects, and do not apply to preview environments. See the full behavior in Observability.

Required permissions

Reading requires read access to the project (project.read on project:<project-id>). Changing requires project.instances.update on the same project. owner has full access; assistant, member, and API Keys need the specific scope.

Read alerts

GET /v1/project/:id/alerts

Requires project.read. Rate limit: 100 requests per minute (counted per source IP).

{
  "status": "success",
  "data": {
    "enabled": false,
    "cpu_threshold_percent": 80,
    "memory_threshold_percent": 80,
    "cooldown_minutes": 60,
    "last_alerts": {
      "error": null,
      "cpu": "2026-10-07T12:00:00.000Z",
      "memory": null
    }
  }
}

The CPU and memory thresholds and the minimum interval between emails are fixed and returned for reading only. last_alerts shows when each alert kind (error, cpu, memory) was sent in the last hour; null when none was sent in that period.

Enable or disable alerts

PATCH /v1/project/:id/alerts

Requires project.instances.update. Rate limit: 20 requests every 5 minutes (counted per source IP).

FieldTypeRequiredDescription
enabledbooleanYestrue enables alerts; false disables them
{
  "enabled": true
}

enabled is required and must be a boolean; otherwise the response is 400. Other fields in the body are ignored.

Both operations return 404 when the project does not exist and 400 when the project is not HTTP or is a preview environment.

Last updated on

On this page