v2

latestSwagger 2.02026-07-136054211.7 KB
Alerts

Creates an alert scoped to the specified business domain.

put/business-domains/{businessDomainId}/alerts/{alertId}

Path parameters

businessDomainIdstring required

Unique identifier for the business domain containing the alerts

alertIdstring required

Unique identifier of the alert to create or replace

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

idstring required

Unique identifier for the alert

namestring required

Human-readable alert name

descriptionstring

Detailed description of the alert

annotationsobject

Key-value annotations for alert categorization

status'Enabled' | 'Disabled' required

Alert status classification

conditionstring required

Condition expression evaluated for alert triggering

receiversstring[] required

Notification receivers for the alert

enabledForFailedJobsboolean required

Flag indicating whether failures automatically enable the alert

createdAtstring date-time

Creation timestamp (UTC)

createdBystring

Creator identity

lastModifiedAtstring date-time

Last modification timestamp (UTC)

lastModifiedBystring

Last modifier identity

Response

The request has succeeded.

idstring required

Unique identifier for the alert

namestring required

Human-readable alert name

descriptionstring

Detailed description of the alert

annotationsobject

Key-value annotations for alert categorization

status'Enabled' | 'Disabled' required

Alert status classification

conditionstring required

Condition expression evaluated for alert triggering

receiversstring[] required

Notification receivers for the alert

enabledForFailedJobsboolean required

Flag indicating whether failures automatically enable the alert

createdAtstring date-time

Creation timestamp (UTC)

createdBystring

Creator identity

lastModifiedAtstring date-time

Last modification timestamp (UTC)

lastModifiedBystring

Last modifier identity