> ## Documentation Index > Fetch the complete documentation index at: https://docs.korve.dev/llms.txt > Use this file to discover all available pages before exploring further. # alertPolicies > Project alert policies for availability, backup, capacity, compute, database, queue, cron, and budget signals with dashboard visibility and organization alert channels. Project alert policies for availability, backup, capacity, compute, database, queue, cron, and budget signals with dashboard visibility and organization alert channels. ## alertPolicies.list List project alert policies. ```text theme={null} GET /v1/orgs/{orgId}/projects/{projectId}/alert-policies ``` * **Auth:** Organization API key (`Authorization: Bearer korve_...`) or dashboard session. * **Minimum role:** `member` * **Risk:** `read` ### Example ```bash theme={null} curl "https://api.korve.dev/v1/orgs/$ORG_ID/projects/$PROJECT_ID/alert-policies" \ -H "Authorization: Bearer korve_..." ``` ### Responses | Status | Description | | ------ | ------------------------------------- | | `200` | Alert policies ordered by name. | | `404` | No such project in this organization. | ### Response body (200) An array of objects with these fields: | Field | Type | Description | | --------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | — | | `name` | string | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | — | | `severity` | string | One of: `info`, `warning`, `critical`. | | `scope` | object | — | | `scope.environment` | string | — | | `scope.databaseId` | string or null | — | | `scope.queueId` | string or null | — | | `scope.cronId` | string or null | — | | `condition` | object | — | | `condition.signal` | string | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | — | | `condition.durationSeconds` | integer | — | | `channelIds` | string\[] | Organization alert channel ids. Dashboard visibility is always included. | | `cooldownSeconds` | integer | — | | `createdAt` | string | Format: `date-time`. | | `updatedAt` | string | Format: `date-time`. | ## alertPolicies.create Create a threshold or platform-health alert policy with one or more organization alert channels. ```text theme={null} POST /v1/orgs/{orgId}/projects/{projectId}/alert-policies ``` * **Auth:** Organization API key (`Authorization: Bearer korve_...`) or dashboard session. * **Minimum role:** `admin` * **Billing:** requires active organization billing — returns `402` otherwise. * **Risk:** `write` ### Request body | Field | Type | Required | Description | | --------------------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | No | — | | `severity` | string | Yes | One of: `info`, `warning`, `critical`. | | `scope` | object | Yes | — | | `scope.environment` | string | Yes | — | | `scope.databaseId` | string or null | Yes | — | | `scope.queueId` | string or null | Yes | — | | `scope.cronId` | string or null | Yes | — | | `condition` | object | Yes | — | | `condition.signal` | string | Yes | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | Yes | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | Yes | — | | `condition.durationSeconds` | integer | Yes | — | | `channelIds` | string\[] | Yes | — | | `cooldownSeconds` | integer | No | — | ### Example ```bash theme={null} curl -X POST "https://api.korve.dev/v1/orgs/$ORG_ID/projects/$PROJECT_ID/alert-policies" \ -H "Authorization: Bearer korve_..." \ -H "Content-Type: application/json" \ -d '{ "name": "example", "severity": "info", "scope": { "environment": "example", "databaseId": "example", "queueId": "example", "cronId": "example" }, "condition": { "signal": "database.unavailable", "operator": "gt", "threshold": 1, "durationSeconds": 1 }, "channelIds": [ "example" ] }' ``` ### Responses | Status | Description | | ------ | ----------------------------------------------- | | `201` | Alert policy created. | | `404` | No such project or scoped resource. | | `409` | An alert policy with that name already exists. | | `422` | Invalid condition, scope, channel, or cooldown. | ### Response body (201) | Field | Type | Description | | --------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | — | | `name` | string | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | — | | `severity` | string | One of: `info`, `warning`, `critical`. | | `scope` | object | — | | `scope.environment` | string | — | | `scope.databaseId` | string or null | — | | `scope.queueId` | string or null | — | | `scope.cronId` | string or null | — | | `condition` | object | — | | `condition.signal` | string | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | — | | `condition.durationSeconds` | integer | — | | `channelIds` | string\[] | Organization alert channel ids. Dashboard visibility is always included. | | `cooldownSeconds` | integer | — | | `createdAt` | string | Format: `date-time`. | | `updatedAt` | string | Format: `date-time`. | ## alertPolicies.get Get one alert policy. ```text theme={null} GET /v1/orgs/{orgId}/projects/{projectId}/alert-policies/{policyId} ``` * **Auth:** Organization API key (`Authorization: Bearer korve_...`) or dashboard session. * **Minimum role:** `member` * **Risk:** `read` ### Example ```bash theme={null} curl "https://api.korve.dev/v1/orgs/$ORG_ID/projects/$PROJECT_ID/alert-policies/$POLICY_ID" \ -H "Authorization: Bearer korve_..." ``` ### Responses | Status | Description | | ------ | ------------------------------------- | | `200` | Alert policy. | | `404` | No such alert policy in this project. | ### Response body (200) | Field | Type | Description | | --------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | — | | `name` | string | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | — | | `severity` | string | One of: `info`, `warning`, `critical`. | | `scope` | object | — | | `scope.environment` | string | — | | `scope.databaseId` | string or null | — | | `scope.queueId` | string or null | — | | `scope.cronId` | string or null | — | | `condition` | object | — | | `condition.signal` | string | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | — | | `condition.durationSeconds` | integer | — | | `channelIds` | string\[] | Organization alert channel ids. Dashboard visibility is always included. | | `cooldownSeconds` | integer | — | | `createdAt` | string | Format: `date-time`. | | `updatedAt` | string | Format: `date-time`. | ## alertPolicies.update Update an alert policy's condition, scope, channels, severity, cooldown, or enabled state. ```text theme={null} PATCH /v1/orgs/{orgId}/projects/{projectId}/alert-policies/{policyId} ``` * **Auth:** Organization API key (`Authorization: Bearer korve_...`) or dashboard session. * **Minimum role:** `admin` * **Billing:** requires active organization billing — returns `402` otherwise. * **Risk:** `write` ### Request body | Field | Type | Required | Description | | --------------------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | No | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | No | — | | `severity` | string | No | One of: `info`, `warning`, `critical`. | | `scope` | object | No | — | | `scope.environment` | string | Yes | — | | `scope.databaseId` | string or null | Yes | — | | `scope.queueId` | string or null | Yes | — | | `scope.cronId` | string or null | Yes | — | | `condition` | object | No | — | | `condition.signal` | string | Yes | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | Yes | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | Yes | — | | `condition.durationSeconds` | integer | Yes | — | | `channelIds` | string\[] | No | — | | `cooldownSeconds` | integer | No | — | ### Example ```bash theme={null} curl -X PATCH "https://api.korve.dev/v1/orgs/$ORG_ID/projects/$PROJECT_ID/alert-policies/$POLICY_ID" \ -H "Authorization: Bearer korve_..." \ -H "Content-Type: application/json" \ -d '{}' ``` ### Responses | Status | Description | | ------ | ---------------------------------------- | | `200` | Updated alert policy. | | `404` | No such alert policy or scoped resource. | | `422` | Invalid alert policy configuration. | ### Response body (200) | Field | Type | Description | | --------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | — | | `name` | string | Pattern: `^[a-z][a-z0-9-]{1,61}$`. | | `enabled` | boolean | — | | `severity` | string | One of: `info`, `warning`, `critical`. | | `scope` | object | — | | `scope.environment` | string | — | | `scope.databaseId` | string or null | — | | `scope.queueId` | string or null | — | | `scope.cronId` | string or null | — | | `condition` | object | — | | `condition.signal` | string | One of: `database.unavailable`, `backup.archive_failed`, `storage.capacity`, `cpu.pressure`, `memory.pressure`, `database.pool_saturation`, `queue.backlog`, `cpu.percent`, `memory.used_bytes`, `memory.limit_bytes`, `disk.used_bytes`, `disk.limit_bytes`, `disk.read_iops`, `disk.write_iops`, `network.receive_bytes`, `network.transmit_bytes`, `runtime.restarts`, `runtime.uptime_seconds`, `http.requests`, `http.errors`, `database.connections`, `database.pool_waiting`, `database.queries_per_second`, `database.query_latency_avg_ms`, `database.query_latency_p50_ms`, `database.query_latency_p90_ms`, `database.query_latency_p95_ms`, `database.query_latency_p99_ms`, `queue.backlog_messages`, `queue.oldest_message_age_seconds`, `cron.failures`. | | `condition.operator` | string | One of: `gt`, `gte`, `lt`, `lte`, `eq`. | | `condition.threshold` | number or null | — | | `condition.durationSeconds` | integer | — | | `channelIds` | string\[] | Organization alert channel ids. Dashboard visibility is always included. | | `cooldownSeconds` | integer | — | | `createdAt` | string | Format: `date-time`. | | `updatedAt` | string | Format: `date-time`. | ## alertPolicies.delete Delete an alert policy. Existing incident history remains retained. ```text theme={null} DELETE /v1/orgs/{orgId}/projects/{projectId}/alert-policies/{policyId} ``` * **Auth:** Organization API key (`Authorization: Bearer korve_...`) or dashboard session. * **Minimum role:** `owner` * **Risk:** `destructive` · sensitive (elevated blast radius) ### Example ```bash theme={null} curl -X DELETE "https://api.korve.dev/v1/orgs/$ORG_ID/projects/$PROJECT_ID/alert-policies/$POLICY_ID" \ -H "Authorization: Bearer korve_..." ``` ### Responses | Status | Description | | ------ | ------------------------------------- | | `200` | Alert policy deleted. | | `404` | No such alert policy in this project. |