Checkly · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Checkly Public Status Pages API
9 actions
9 updates
phrasing
extends
openapi/checkly-status-pages-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/status-pages'].get
$.paths['/v1/status-pages'].post
$.paths['/v1/status-pages/{statusPageId}'].get
$.paths['/v1/status-pages/{statusPageId}'].put
$.paths['/v1/status-pages/{statusPageId}'].delete
$.paths['/v1/status-pages/{statusPageId}/subscriptions'].get
$.paths['/v1/status-pages/{statusPageId}/subscriptions/bulk'].post
$.paths['/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}'].delete
OpenAPI Overlay
# 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 Status Pages API
version: 1.0.0
extends: openapi/checkly-status-pages-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: 8
- target: $.paths['/v1/status-pages'].get
update:
x-apievangelist-phrasing:
intent: List status pages
effect: read
questions:
- Which status pages exist in my account?
- Can I page through all my status pages?
instructions:
- text: List all my status pages.
- text: Show {limit} status pages after {nextId}.
slots:
limit: query.limit
nextId: query.nextId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages'].post
update:
x-apievangelist-phrasing:
intent: Create a status page
effect: write
questions:
- How do I publish a new public status page?
- Can a new status page use a custom domain and my own logo?
instructions:
- text: Create status page {name} at {url} with cards {cards}.
slots:
name: requestBody.name
url: requestBody.url
cards: requestBody.cards
- text: Create status page {name} at {url} on custom domain {customDomain} with cards {cards}.
slots:
name: requestBody.name
url: requestBody.url
customDomain: requestBody.customDomain
cards: requestBody.cards
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}'].get
update:
x-apievangelist-phrasing:
intent: Get a status page with cards (deprecated)
effect: read
questions:
- What cards and services are on one of my status pages?
- Is the v1 single status page read still available?
instructions:
- text: Show status page {statusPageId} with its cards and services.
slots:
statusPageId: path.statusPageId
- text: Get status page {statusPageId} using the deprecated v1 read.
slots:
statusPageId: path.statusPageId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}'].put
update:
x-apievangelist-phrasing:
intent: Update a status page
effect: write
questions:
- Can I change the name, URL or theme of an existing status page?
- What must I send when updating a status page's cards?
instructions:
- text: Update status page {statusPageId} to name {name}, URL {url} and cards {cards}.
slots:
statusPageId: path.statusPageId
name: requestBody.name
url: requestBody.url
cards: requestBody.cards
- text: Switch status page {statusPageId} to theme {defaultTheme}, keeping name {name}, URL {url} and cards {cards}.
slots:
statusPageId: path.statusPageId
defaultTheme: requestBody.defaultTheme
name: requestBody.name
url: requestBody.url
cards: requestBody.cards
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a status page
effect: destructive
questions:
- How do I take down a status page I no longer need?
- Can I delete a status page entirely?
instructions:
- text: Delete status page {statusPageId}.
slots:
statusPageId: path.statusPageId
- text: Remove status page {statusPageId} from my account.
slots:
statusPageId: path.statusPageId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions'].get
update:
x-apievangelist-phrasing:
intent: List a status page's subscriptions
effect: read
questions:
- Who is subscribed to updates from a given status page?
- Can I see all subscriptions for one status page?
instructions:
- text: List subscriptions for status page {statusPageId}.
slots:
statusPageId: path.statusPageId
- text: Show who subscribes to status page {statusPageId}.
slots:
statusPageId: path.statusPageId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions/bulk'].post
update:
x-apievangelist-phrasing:
intent: Bulk add subscribers to a status page
effect: write
questions:
- Can I import many subscribers onto a status page in one go?
- Is it possible to skip verification when bulk adding subscribers?
instructions:
- text: Add subscriptions {subscriptions} to status page {statusPageId}.
slots:
subscriptions: requestBody.subscriptions
statusPageId: path.statusPageId
- text: Bulk subscribe {subscriptions} to page {statusPageId} with auto-verify {autoVerify}.
slots:
subscriptions: requestBody.subscriptions
statusPageId: path.statusPageId
autoVerify: requestBody.autoVerify
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a subscription from a status page
effect: destructive
questions:
- How do I unsubscribe someone from a status page?
- Can I delete one subscription by its ID?
instructions:
- text: Delete subscription {subscriptionId} from status page {statusPageId}.
slots:
subscriptionId: path.subscriptionId
statusPageId: path.statusPageId
- text: Unsubscribe {subscriptionId} from page {statusPageId}.
slots:
subscriptionId: path.subscriptionId
statusPageId: path.statusPageId
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/checkly-status-pages-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.