@akamai/openapi-ts
    Preparing search index...

    Type Alias GetAlertDefinitionsResponses

    type GetAlertDefinitionsResponses = {
        "200": {
            data: {
                alert_channels: {
                    id: number;
                    label: string;
                    type: "email";
                    url: string;
                }[];
                class: "shared"
                | "dedicated";
                created: string;
                created_by: string;
                description: string;
                entity_ids: string[];
                has_more_resources: boolean;
                id: number;
                label: string;
                rule_criteria: {
                    rules: {
                        aggregate_function: "avg" | "sum" | "min" | "max";
                        dimension_filters: {
                            dimension_label: string;
                            label: string;
                            operator: "eq" | "neq" | "startswith" | "endswith";
                            value: string;
                        }[];
                        label: string;
                        metric: string;
                        operator: "eq"
                        | "gt"
                        | "lt"
                        | "gte"
                        | "lte";
                        threshold: number;
                        unit:
                            | "number"
                            | "byte"
                            | "second"
                            | "percent"
                            | "bit_per_second"
                            | "millisecond"
                            | "KB"
                            | "MB"
                            | "GB";
                    }[];
                };
                service_type: string;
                severity: 0
                | 1
                | 2
                | 3;
                status: "enabled" | "disabled" | "in progress" | "failed";
                trigger_conditions: {
                    criteria_condition: "ALL";
                    evaluation_period_seconds: number;
                    polling_interval_seconds: number;
                    trigger_occurrences: number;
                };
                type: "user"
                | "system";
                updated: string;
                updated_by: string;
            }[];
            page: number;
            pages: number;
            results: number;
        };
    }
    Index

    Properties

    Properties

    "200": {
        data: {
            alert_channels: {
                id: number;
                label: string;
                type: "email";
                url: string;
            }[];
            class: "shared"
            | "dedicated";
            created: string;
            created_by: string;
            description: string;
            entity_ids: string[];
            has_more_resources: boolean;
            id: number;
            label: string;
            rule_criteria: {
                rules: {
                    aggregate_function: "avg" | "sum" | "min" | "max";
                    dimension_filters: {
                        dimension_label: string;
                        label: string;
                        operator: "eq" | "neq" | "startswith" | "endswith";
                        value: string;
                    }[];
                    label: string;
                    metric: string;
                    operator: "eq"
                    | "gt"
                    | "lt"
                    | "gte"
                    | "lte";
                    threshold: number;
                    unit:
                        | "number"
                        | "byte"
                        | "second"
                        | "percent"
                        | "bit_per_second"
                        | "millisecond"
                        | "KB"
                        | "MB"
                        | "GB";
                }[];
            };
            service_type: string;
            severity: 0
            | 1
            | 2
            | 3;
            status: "enabled" | "disabled" | "in progress" | "failed";
            trigger_conditions: {
                criteria_condition: "ALL";
                evaluation_period_seconds: number;
                polling_interval_seconds: number;
                trigger_occurrences: number;
            };
            type: "user"
            | "system";
            updated: string;
            updated_by: string;
        }[];
        page: number;
        pages: number;
        results: number;
    }

    Returns a paginated list of all alert definitions.

    Type Declaration

    • data: {
          alert_channels: {
              id: number;
              label: string;
              type: "email";
              url: string;
          }[];
          class: "shared"
          | "dedicated";
          created: string;
          created_by: string;
          description: string;
          entity_ids: string[];
          has_more_resources: boolean;
          id: number;
          label: string;
          rule_criteria: {
              rules: {
                  aggregate_function: "avg" | "sum" | "min" | "max";
                  dimension_filters: {
                      dimension_label: string;
                      label: string;
                      operator: "eq" | "neq" | "startswith" | "endswith";
                      value: string;
                  }[];
                  label: string;
                  metric: string;
                  operator: "eq"
                  | "gt"
                  | "lt"
                  | "gte"
                  | "lte";
                  threshold: number;
                  unit:
                      | "number"
                      | "byte"
                      | "second"
                      | "percent"
                      | "bit_per_second"
                      | "millisecond"
                      | "KB"
                      | "MB"
                      | "GB";
              }[];
          };
          service_type: string;
          severity: 0
          | 1
          | 2
          | 3;
          status: "enabled" | "disabled" | "in progress" | "failed";
          trigger_conditions: {
              criteria_condition: "ALL";
              evaluation_period_seconds: number;
              polling_interval_seconds: number;
              trigger_occurrences: number;
          };
          type: "user"
          | "system";
          updated: string;
          updated_by: string;
      }[]
    • Readonlypage: number

      Read-only The current page.

    • Readonlypages: number

      Read-only The total number of pages.

    • Readonlyresults: number

      Read-only The total number of results.