Schemas

The region in which the alert is defined.

Indicates if the alert is preconfigured or custom.

Name of the alert.

Rule defining the alert condition.

Duration for which the alert must be active before firing. The format of this duration follows the prometheus duration format.

Indicates if the alert is enabled, enabling, disabled or disabling. Preconfigured alerts can have any of these values, whereas custom alerts can only have the status "enabled".

Current state of the alert. Possible states are inactive, pending, and firing.

Annotations for the alert, used to provide additional information about the alert.

Contains additional data for preconfigured alerts, such as the rule ID, display name, and description. Only present if the alert is preconfigured.

ID of the data source containing the alert rule. (UUID format)

Alert manager URL.

The Alert manager is enabled.

Managed alerts are enabled.

Regions where the Alert manager is enabled.

Email address to send alerts to.

Region.

Send an email notification when an alert is marked as resolved.

ID of the data source. (UUID format)

ID of the Project the data source belongs to. (UUID format)

Data source name.

Data source URL.

Data source type.

Data source origin.

Date the data source was created. (RFC 3339 format)

Date the data source was last updated. (RFC 3339 format)

Indicates whether the data source is synchronized with Grafana.

Duration for which the data will be retained in the data source.

Region of the data source.

Usage of the month in bytes. (in bytes)

List of IDs of the rules that were disabled. Only newly disabled rules are listed. Rules that were already disabled are not returned in the output. (UUID format)

List of IDs of the rules that were enabled. Only newly enabled rules are listed. Rules that were already enabled are not returned in the output. (UUID format)

ID of the data export. (UUID format)

Name of the data export.

Description of the data export.

ID of the data source linked to the data export. (UUID format)

Datadog destination configuration for the data export.

OTLP destination configuration for the data export.

Status of the data export.

List of Scaleway products name exported by the data export.

A timestamp of the creation date of the data export. (RFC 3339 format)

A timestamp of the last update date of the data export. (RFC 3339 format)

The region in which the export is located.

Custom metrics retention configuration.

Custom logs retention configuration.

Custom traces retention configuration.

Scaleway metrics retention configuration.

Scaleway logs retention configuration.

Total count of rules grouped by data source.

Total count of preconfigured rules.

Total count of custom rules.

Total count of alerts matching the request.

List of alerts matching the applied filters.

Total count of contact points associated with the default receiver.

List of contact points associated with the default receiver.

Indicates whether the Alert manager has other receivers than the default one.

Indicates whether there are unmanaged contact points on the default receiver.

Total count of data sources matching the request.

Data sources matching the request within the pagination.

Total count of data exports matching the request.

Data exports matching the request within the pagination.

Total count of tokens matching the request.

Tokens matching the request within the pagination.

ID of the data source. (UUID format)

Name of the data source.

Total count of rules associated with this data source.

ID of the token.

ID of the Project the token belongs to.

Name of the token.

Token creation date. (RFC 3339 format)

Token last modification date. (RFC 3339 format)

Token permission scopes.

Token secret key.

Regions where the token is located.

ID of the data source.

ID of the Project the data source belongs to. (UUID format)

Origin of the data source.

Type of the data source.

Unit of the data source usage.

Interval for the data source usage. (in seconds)

Data source usage for the given interval.

Region of the data source usage.