Skip to main content

Interface: MonitorCreationData

Defined in: src/utils/monitorValidation.ts:33

Required fields for monitor creation, ensuring type safety. Prevents runtime errors by guaranteeing essential properties are present.

Hierarchyโ€‹

View Summary

Extendsโ€‹

  • Pick<Monitor, | "history" | "monitoring" | "responseTime" | "retryAttempts" | "status" | "timeout" | "type">.UnknownRecord

Indexableโ€‹

[key: string]: unknown
[key: number]: unknown
[key: symbol]: unknown

Propertiesโ€‹

historyโ€‹

history: StatusHistory[];

Defined in: shared/types.ts:287

Historical status data for analytics and trends

Inherited fromโ€‹

Monitor.history


monitoringโ€‹

monitoring: boolean;

Defined in: shared/types.ts:303

Whether monitoring is currently active for this monitor

Inherited fromโ€‹

Monitor.monitoring


responseTimeโ€‹

responseTime: number;

Defined in: shared/types.ts:315

Latest response time measurement in milliseconds

Inherited fromโ€‹

Monitor.responseTime


retryAttemptsโ€‹

retryAttempts: number;

Defined in: shared/types.ts:317

Number of retry attempts when a check fails

Inherited fromโ€‹

Monitor.retryAttempts


statusโ€‹

status: "degraded" | "down" | "paused" | "pending" | "up";

Defined in: shared/types.ts:319

Current status of the monitor

Inherited fromโ€‹

Monitor.status


timeoutโ€‹

timeout: number;

Defined in: shared/types.ts:321

Timeout for monitor checks in milliseconds

Inherited fromโ€‹

Monitor.timeout


typeโ€‹

type:
| "cdn-edge-consistency"
| "dns"
| "http"
| "http-header"
| "http-json"
| "http-keyword"
| "http-latency"
| "http-status"
| "ping"
| "port"
| "replication"
| "server-heartbeat"
| "ssl"
| "websocket-keepalive";

Defined in: shared/types.ts:325

Type of monitoring performed (see BASE_MONITOR_TYPES).

Inherited fromโ€‹

Monitor.type