Templates

Get system prebuilt templates

Retrieves all system-defined prebuilt templates. These templates are provided by OpenObserve for common notification destinations like Slack, Microsoft Teams, Email, PagerDuty, etc. System templates are read-only and serve as the foundation for prebuilt alert destinations. This endpoint returns the complete template configurations including body, type, and metadata. Requires LIST permission on templates.

get/api/{org_id}/alerts/templates/system/prebuilt

Request

Path parameters

org_idstring required

Organization name

Response

Success

applies_tostring[] nullable

Kinds the template is meant for; [] is every kind. Absent on update keeps the stored list.

bodystring
isDefaultboolean nullable
isPrebuiltboolean

True for system-managed prebuilt templates (those whose name starts with prebuilt_). The public API refuses updates and deletes for these, so the UI should render them as read-only.

kindstring nullable

Template kind: "custom" (default) or "content". Absent on write means "unspecified" — create defaults to custom, update preserves the stored kind (sticky-kind rule, design §6.2).

namestring
titlestring
type'http' | 'email' | 'sns' | 'slack_app'

Changes

No recorded changes to this operation across all 1 revision of this API.