List Alert Rules
const url = 'https://example.com/observability/v1/workspaces/example/engines/example/alert-rules';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/observability/v1/workspaces/example/engines/example/alert-rulesReturns a paginated list of alert rules. A specific provider filters to that provider; - lists
across all providers.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace whose alert rules to list.
The provider: qibdo, aws, gcp, or azure, or ’-’ to list across all providers.
Query Parameters
Section titled “Query Parameters ”The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 20 items will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token from a previous ListAlertRules call.
AIP-160 filter expression.
AIP-132 order_by expression, e.g. ‘created desc’.
Responses
Section titled “ Responses ”OK
ListAlertRulesResponse
Response for ListAlertRules. Keyset pagination intentionally omits total_size (AIP-158).
object
The list of alert rules.
An alert rule evaluates a PromQL/LogQL expression over a signal (metric or log) and, for ALERT-kind
rules, routes fired alerts through a notification tree to webhook, email, or app-message receivers.
A RECORDING-kind rule instead precomputes a derived series and needs no route. The provider that
evaluates the rule is reported by the read-only engine field.
object
The unique identifier of the alert rule.
The workspace this rule belongs to. Derived from the {workspace} path segment on create;
reported read-only thereafter.
Weak reference to a topology Location — where the telemetry resides. Immutable after create.
The rule’s handle: a DNS-label (lowercase alphanumerics and hyphens, up to 63 characters), unique within the workspace. Set on create, immutable thereafter.
Whether the rule raises notifications (ALERT) or precomputes a series (RECORDING). Immutable after create.
The signal the rule’s expression evaluates over (metric or log). Immutable after create.
The provider that evaluates this rule.
Timestamp when the rule was created.
Timestamp when the rule was last updated.
Rule spec for a Qibdo-managed alert rule.
object
The PromQL/LogQL expression the rule evaluates (required).
Pending duration in seconds the condition must hold before firing. 0 (or unset) means fire immediately.
Labels stamped onto fired alerts.
object
Annotations attached to fired alerts.
object
The notification routing tree. Optional; a recording rule omits it.
object
Label keys to group fired alerts by before notifying.
Label-equality predicates selecting which fired alerts this route applies to.
A label-equality predicate selecting which fired alerts a route applies to.
object
The alert label to match on.
The value the label must equal.
More specific routes evaluated within this one.
A node in an alert rule’s notification routing tree: group fired alerts, select them by matchers, deliver to receivers, and recurse into more specific child routes.
object
Label keys to group fired alerts by before notifying.
Label-equality predicates selecting which fired alerts this route applies to.
A label-equality predicate selecting which fired alerts a route applies to.
object
The alert label to match on.
The value the label must equal.
The receivers fired alerts matching this route are delivered to.
A delivery target for a fired alert — exactly one channel arm is set.
object
Generic HTTP callback delivery.
object
The callback URL fired alerts are POSTed to.
Email delivery.
object
The recipient email addresses.
Slack delivery.
object
The Slack channel fired alerts are delivered to.
A weak reference to the Slack credential (never an inline secret).
The receivers fired alerts matching this route are delivered to.
A delivery target for a fired alert — exactly one channel arm is set.
object
Generic HTTP callback delivery.
object
The callback URL fired alerts are POSTed to.
Email delivery.
object
The recipient email addresses.
Slack delivery.
object
The Slack channel fired alerts are delivered to.
A weak reference to the Slack credential (never an inline secret).
A token to retrieve the next page; empty when there are no further pages.
Example
{ "alert_rules": [ { "kind": "ALERT_KIND_UNSPECIFIED", "signal": "ALERT_SIGNAL_UNSPECIFIED", "engine": "ENGINE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}