nodes/generated

Interface UptimeRobotNodeParameters

Source
interface UptimeRobotNodeParameters {
    additionalFields?: {
        custom_domain?: string;
        password?: string;
        sort?: 1 | 3 | 2 | 4;
    };
    duration?: number;
    filters?: | {
        alert_contacts?: boolean;
        logs?: boolean;
        monitors?: string;
        mwindow?: boolean;
        response_times?: boolean;
        search?: string;
        statuses?: (0 | 1 | 2 | 8 | 9)[];
        types?: (1 | 2 | 3 | 4 | 5)[];
    }
    | { alert_contacts?: string }
    | { mwindow?: string }
    | { psps?: string };
    friendlyName?: string;
    id?: string;
    limit?: number;
    monitors?: string;
    monthDay?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "reset";
    resource?: | "account"
    | "alertContact"
    | "maintenanceWindow"
    | "monitor"
    | "publicStatusPage";
    returnAll?: boolean;
    start_time?: string;
    type?: 1
    | 3
    | 2
    | 4
    | 5
    | 6
    | 9;
    updateFields?:
        | {
            friendly_name?: string;
            http_auth_type?: 1
            | 2;
            http_method?: 1 | 3 | 2 | 4 | 5 | 6 | 7;
            http_password?: string;
            http_username?: string;
            interval?: number;
            port?: number;
            status?: 0 | 1;
            sub_type?: 1 | 3 | 2 | 4 | 5 | 6 | 99;
            url?: string;
        }
        | { friendly_name?: string; value?: string }
        | {
            friendly_name?: string;
            monthDay?: number;
            start_time?: string;
            type?: 1 | 3 | 2 | 4;
            weekDay?: 1 | 3 | 2 | 4 | 5 | 6 | 7;
        }
        | {
            custom_domain?: string;
            friendly_name?: string;
            monitors?: string;
            password?: string;
            sort?: 1
            | 3
            | 2
            | 4;
        };
    url?: string;
    value?: string;
    weekDay?: 1
    | 3
    | 2
    | 4
    | 5
    | 6
    | 7;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly duration?: number

The maintenance window activation period (minutes) Default: 1

§readonly filters?:
    | {
        alert_contacts?: boolean;
        logs?: boolean;
        monitors?: string;
        mwindow?: boolean;
        response_times?: boolean;
        search?: string;
        statuses?: (0 | 1 | 2 | 8 | 9)[];
        types?: (1 | 2 | 3 | 4 | 5)[];
    }
    | { alert_contacts?: string }
    | { mwindow?: string }
    | { psps?: string }

Default: {}

§readonly friendlyName?: string

The friendly name of the monitor

§readonly id?: string

The ID of the monitor

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

§readonly monitors?: string

Monitor IDs to be displayed in status page (the values are separated with a dash (-) or 0 for all monitors)

§readonly monthDay?: number

Default: 1 Type options: {"minValue":1,"maxValue":30}

§readonly operation?: "create" | "get" | "getAll" | "update" | "delete" | "reset"

Default: "get"

§readonly resource?:
    | "account"
    | "alertContact"
    | "maintenanceWindow"
    | "monitor"
    | "publicStatusPage"

Default: "account"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly start_time?: string

The maintenance window start datetime

§readonly type?: 1 | 3 | 2 | 4 | 5 | 6 | 9

The type of the monitor

§readonly updateFields?:
    | {
        friendly_name?: string;
        http_auth_type?: 1
        | 2;
        http_method?: 1 | 3 | 2 | 4 | 5 | 6 | 7;
        http_password?: string;
        http_username?: string;
        interval?: number;
        port?: number;
        status?: 0 | 1;
        sub_type?: 1 | 3 | 2 | 4 | 5 | 6 | 99;
        url?: string;
    }
    | { friendly_name?: string; value?: string }
    | {
        friendly_name?: string;
        monthDay?: number;
        start_time?: string;
        type?: 1 | 3 | 2 | 4;
        weekDay?: 1 | 3 | 2 | 4 | 5 | 6 | 7;
    }
    | {
        custom_domain?: string;
        friendly_name?: string;
        monitors?: string;
        password?: string;
        sort?: 1
        | 3
        | 2
        | 4;
    }

Default: {}

§readonly url?: string

The URL/IP of the monitor

§readonly value?: string

The correspondent value for the alert contact type

§readonly weekDay?: 1 | 3 | 2 | 4 | 5 | 6 | 7