@fibercom/routeros-api/dist/IRosOptions.d.ts

Robust MikroTik RouterOS API client for Node.js and TypeScript

import { TlsOptions } from "tls";
/**
 * RouterOS API Connection Options
 *
 * Interface defining configuration used to connect to a MikroTik RouterOS device.
 */
export interface IRosOptions {
    /** Router IP or hostname */
    host: string;
    /** Optional username for authentication */
    user?: string;
    /** Optional password for authentication */
    password?: string;
    /** API port (default: 8728 for plain, 8729 for TLS) */
    port?: number;
    /** Socket timeout in seconds (default: 5) */
    timeout?: number;
    /** TLS connection options; if set, enables TLS mode */
    tls?: TlsOptions;
    /** Keepalive behavior (default: false); not yet implemented internally */
    keepalive?: boolean;
    debug?: boolean;
}