Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Monitors API

8 actions 8 updates phrasing extends openapi/checkly-monitors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/v1/checks/dns/{id}'].put
$.paths['/v1/checks/icmp'].post
$.paths['/v1/checks/icmp/{id}'].put
$.paths['/v1/checks/ssl'].post
$.paths['/v1/checks/ssl/{id}'].put
$.paths['/v1/checks/url'].post
$.paths['/v1/checks/url/{id}'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Monitors API
  version: 1.0.0
extends: openapi/checkly-monitors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/checks/dns/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DNS monitor
      effect: write
      questions:
      - Can I change the record or domain an existing DNS monitor looks up?
      - Is it possible to rename a DNS monitor I already set up?
      instructions:
      - text: Rename DNS monitor {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update DNS monitor {id}, named {name}, to query {request}.
        slots:
          id: path.id
          name: requestBody.name
          request: requestBody.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/icmp'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ICMP ping monitor
      effect: write
      questions:
      - How do I ping a host regularly to see if it's reachable?
      - Can a ping monitor alert on packet loss above a threshold?
      instructions:
      - text: Create an ICMP monitor named {name} pinging {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add ping monitor {name} for {request} that fails above {maxPacketLossThreshold}% packet loss.
        slots:
          name: requestBody.name
          request: requestBody.request
          maxPacketLossThreshold: requestBody.maxPacketLossThreshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/icmp/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ICMP ping monitor
      effect: write
      questions:
      - Can I adjust the packet loss thresholds on an existing ping monitor?
      - What can I change on an ICMP monitor after creating it?
      instructions:
      - text: Set ICMP monitor {id} to degrade at {degradedPacketLossThreshold}% packet loss.
        slots:
          id: path.id
          degradedPacketLossThreshold: requestBody.degradedPacketLossThreshold
      - text: Point ping monitor {id} at {request}.
        slots:
          id: path.id
          request: requestBody.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/ssl'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSL certificate monitor
      effect: write
      questions:
      - How can I be warned before my site's SSL certificate has problems?
      - What's needed to create an SSL monitor for a domain?
      instructions:
      - text: Create an SSL monitor named {name} for {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add SSL monitor {name} checking {request} every {frequency} minutes.
        slots:
          name: requestBody.name
          request: requestBody.request
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/ssl/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SSL certificate monitor
      effect: write
      questions:
      - Can I change which host an existing SSL monitor inspects?
      - Is there a way to mute an SSL monitor temporarily?
      instructions:
      - text: Update SSL monitor {id} to inspect {request}.
        slots:
          id: path.id
          request: requestBody.request
      - text: Mute SSL monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/url'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a URL uptime monitor
      effect: write
      questions:
      - How do I monitor that a web address stays up?
      - Can a URL monitor mark a page degraded when it's slow to respond?
      instructions:
      - text: Create a URL monitor named {name} for {request}.
        slots:
          name: requestBody.name
          request: requestBody.request
      - text: Add URL monitor {name} on {request} from {locations} every {frequency} minutes.
        slots:
          name: requestBody.name
          request: requestBody.request
          locations: requestBody.locations
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/url/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL uptime monitor
      effect: write
      questions:
      - Can I change the address an existing URL monitor watches?
      - Is it possible to change how often a URL monitor runs?
      instructions:
      - text: Update URL monitor {id} to watch {request}.
        slots:
          id: path.id
          request: requestBody.request
      - text: Make URL monitor {id} run every {frequency} minutes.
        slots:
          id: path.id
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-26'