@videosdk.live/server-sdk
    Preparing search index...

    Interface ListAlertRulesParams

    Common pagination query parameters accepted by list endpoints.

    interface ListAlertRulesParams {
        cursor?: string;
        domain?: AlertDomain;
        metricCategory?: string;
        page?: number;
        perPage?: number;
        region?: string;
        status?: AlertRuleStatus;
    }

    Hierarchy (View Summary)

    Index
    cursor? domain? metricCategory? page? perPage? region? status?
    cursor?: string

    Opaque cursor from a previous Page.nextCursor. Overrides page/perPage.

    domain?: AlertDomain

    Filter by domain. NOTE: the server defaults to "rtc" when omitted — pass "agent" to see agent-domain rules.

    metricCategory?: string

    Optionalpage

    page?: number

    1-based page number. Defaults server-side to 1.

    perPage?: number

    Items per page. Server default is 10 or 20 depending on the resource.

    region?: string
    status?: AlertRuleStatus

    Settings
    Member Visibility

    On This Page
    Properties