Get Monitor
getMonitorRetrieve configuration details for a specific uptime monitor by its ID, such as URL, check interval, and notification settings, to review or adjust its setup.
Instructions
Retrieves configuration details for a specific monitor by ID (URL, check interval, notification settings, etc.). Use this when you need to examine or modify settings for a specific monitor. For current status, use getMonitorSummary instead. By default returns only common fields plus runtime data (uptime, avgPing); set includeTypeSpecificFields to true to include type-specific fields (e.g., url for HTTP, hostname/port for TCP).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| monitorID | Yes | The ID of the monitor to retrieve | |
| includeSecrets | No | Return credentials in full instead of "***". Off by default: this output is persisted in conversation transcripts and logs. Can also be enabled globally with UPTIME_KUMA_INCLUDE_SECRETS=true. | |
| includeTypeSpecificFields | No | Include type-specific fields (url, hostname, port, etc.) in addition to common fields. Default: false. When false, only returns MonitorBase fields plus uptime/avgPing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| monitor | Yes | Monitor object with common fields plus uptime/avgPing. May include type-specific fields when includeTypeSpecificFields is true. Credentials (pushToken, basic_auth_pass, bearer_token, headers, ...) read "***" unless includeSecrets is set. |