@tikoci/centrs
    Preparing search index...

    Interface ApiRequest

    interface ApiRequest {
        cdbFile?: string;
        cdbPassword?: string;
        confirm?: (prompt: string) => Promise<boolean>;
        count?: number;
        data?: string;
        duration?: string;
        endpoint: string;
        fields?: Record<string, string>;
        format?: string;
        host?: string;
        inputBody?: string;
        insecure?: boolean;
        listen?: boolean;
        method?: string;
        password?: string;
        port?: number;
        proplist?: readonly string[];
        query?: readonly string[];
        raw?: boolean;
        rawQuery?: readonly string[];
        resolve?: string;
        stdinIsTty?: boolean;
        targetInput?: string;
        timeout?: string | number;
        username?: string;
        validate?: boolean;
        verbose?: boolean;
        via?: string;
        yes?: boolean;
    }
    Index

    Properties

    cdbFile? cdbPassword? confirm? count? data? duration? endpoint fields? format? host? inputBody? insecure? listen? method? password? port? proplist? query? raw? rawQuery? resolve? stdinIsTty? targetInput? timeout? username? validate? verbose? via? yes?

    Properties

    cdbFile?: string
    cdbPassword?: string
    confirm?: (prompt: string) => Promise<boolean>
    count?: number

    --count: bound a --listen stream to N frames (later phase).

    data?: string

    -d raw JSON body. Mutually exclusive with fields / inputBody.

    duration?: string

    --duration: bound a --listen stream (later phase).

    endpoint: string

    REST-style endpoint path, leniently normalized (ip/address, /rest/ip/address, "ip address", ip/address/*1, ip/address/listen).

    fields?: Record<string, string>

    -f key=value fields, merged into the JSON body (verbatim string values).

    format?: string
    host?: string
    inputBody?: string

    --input raw JSON body (file/stdin content already read). Mutually exclusive with fields / data.

    insecure?: boolean
    listen?: boolean

    --listen: native-api-only open-ended follow (later phase; rejected here).

    method?: string

    HTTP method (-X), default GET, case-insensitive.

    password?: string
    port?: number
    proplist?: readonly string[]

    --proplist / --attribute property projection.

    query?: readonly string[]

    --query / --filter expressions (name=value, name!=value, name>value, name).

    raw?: boolean

    --raw: bare RouterOS body passthrough; implies --validate=false.

    rawQuery?: readonly string[]

    --raw-query verbatim RouterOS query words (no leading ?).

    resolve?: string

    Opt-in host ARP resolution for a MAC target (none default, or arp).

    stdinIsTty?: boolean
    targetInput?: string
    timeout?: string | number
    username?: string
    validate?: boolean
    verbose?: boolean
    via?: string
    yes?: boolean

    Settings

    Member Visibility

    On This Page

    Properties