Create a notification alert rule

POST

/api/notifications/alert-rules

curl --request POST \
  --url https://gateway.example.com/api/notifications/alert-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "enabled": false, "type": "threshold", "category": "hosting_vm", "severity": "info", "metric": "example", "metricTarget": "example", "operator": ">", "thresholdValue": 1, "durationSeconds": 0, "fireThresholdPercent": 100, "resolveAfterSeconds": 60, "resolveThresholdPercent": 100, "eventPattern": "example", "resourceIds": [], "messageTemplate": "example", "webhookIds": [], "cooldownSeconds": 900 }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Optional retry key (1-255 printable ASCII characters), bound to your token or session and its current scopes. A retry with the same key and request within 24 hours replays the original response with Idempotency-Replayed: true; a different request under the same key returns 422 IDEMPOTENCY_KEY_REUSED, a retry while the first request still runs returns 409 IDEMPOTENCY_KEY_IN_PROGRESS with Retry-After, and a completed request whose response was not stored returns 409 IDEMPOTENCY_RESPONSE_WITHHELD.

Request Body^required

JSON request body

Media typeapplication/json

object

name

required

string

>= 1 characters <= 255 characters

enabled

boolean

type

required

string

Allowed values: threshold event

category

required

string

Allowed values: hosting_vm hosting_account node container build compose proxy pages gateway logging integration certificate security database_postgres database_clickhouse database_redis

severity

string

default: warning

Allowed values: info warning critical

metric

string

<= 100 characters

metricTarget

string | null

<= 255 characters

operator

string

Allowed values: > >= < <=

thresholdValue

number

durationSeconds

integer

0

fireThresholdPercent

integer

default: 100 <= 100

resolveAfterSeconds

integer

default: 60

resolveThresholdPercent

integer

default: 100 <= 100

eventPattern

string

<= 255 characters

resourceIds

Array<string>

default:

messageTemplate

string

<= 4096 characters

webhookIds

Array<string>

default:

cooldownSeconds

integer

default: 900

Responses

201

Created

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Slack alerts",
    "enabled": true,
    "status": "success"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}