Skip to content

keyword

HTTP monitor that checks for the presence (or absence) of a keyword in the response body.

Properties

Property Example Description
accepted_statuscodes 200-299 Accepted HTTP status codes
active true Whether the monitor is active
authMethod basic Authentication method
basic_auth_user monitor Basic auth username
basic_auth_pass secret Basic auth password
oauth_auth_method client_secret_basic OAuth method
oauth_client_id monitor-client OAuth client ID
oauth_token_url https://auth.example.com/oauth/token OAuth token endpoint
oauth_client_secret secret OAuth client secret
oauth_scopes uptime.read OAuth scopes
auth_domain EXAMPLE NTLM auth domain
auth_workstation WORKSTATION1 NTLM workstation
tls_cert -----BEGIN CERTIFICATE-----... Client TLS certificate
tls_key -----BEGIN PRIVATE KEY-----... Client TLS private key
tls_ca -----BEGIN CERTIFICATE-----... Custom CA certificate
body {"status":"ok"} Request body
description A Monitor Monitor description
expiry_notification true Notify on TLS certificate expiry
headers {"X-Api-Key":"secret"} Custom request headers
http_body_encoding json Body encoding
ignore_tls false Ignore TLS errors
interval 60 Check interval in seconds
invert_keyword false Fail if keyword is found (instead of passing)
keyword healthy Keyword to search for in the response body
max_redirects 10 Maximum redirects
max_retries 0 Maximum retries
method GET HTTP method
name Example Monitor display name
parent 0 Parent group ID
proxy_id 1 Proxy ID
retry_interval 60 Interval between retries in seconds
timeout 48 Request timeout in seconds
upside_down false Invert the status
url https://example.com URL to monitor

Example

labels:
  kuma.my-app.keyword.name: "My App Keyword Check"
  kuma.my-app.keyword.url: "https://example.com"
  kuma.my-app.keyword.keyword: "Welcome"