Generated by API Evangelist
Written by API Evangelist tooling for BigPanda's API. It is a proposal applied on top of the contract, not a document BigPanda publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Bigpanda Alerts API
version: 1.0.0
extends: openapi/bigpanda-alerts-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: 3
- target: $.paths['/data/v2/alerts'].post
update:
x-apievangelist-phrasing:
intent: Send a monitoring alert into BigPanda
effect: write
questions:
- How do I push an alert from my own monitoring script into BigPanda?
- What fields does an alert need so BigPanda can correlate it into incidents?
instructions:
- text: Send a {status} alert for host {host} using app key {app_key}.
slots:
status: requestBody.status
host: requestBody.host
app_key: requestBody.app_key
- text: Raise a {status} alert on {host} for check {check} with description {description} via app key {app_key}.
slots:
status: requestBody.status
host: requestBody.host
check: requestBody.check
description: requestBody.description
app_key: requestBody.app_key
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/batch-resolve/alerts'].post
update:
x-apievangelist-phrasing:
intent: Resolve a batch of alerts
effect: write
questions:
- Can I set a whole list of alerts back to OK in one call?
- How do I bulk-resolve stale alerts in an environment?
instructions:
- text: Resolve alerts {ids} in environment {environment_id}.
slots:
ids: requestBody.ids
environment_id: path.environment_id
- text: Mark alerts {ids} in {environment_id} as OK with comment {comments}.
slots:
ids: requestBody.ids
environment_id: path.environment_id
comments: requestBody.comments
method: generated
generated: '2026-09-26'
- target: $.paths['/resources/v2.0/tags'].get
update:
x-apievangelist-phrasing:
intent: List destination tags by most recent
effect: read
questions:
- Which destination tags has BigPanda received most recently?
- Can I filter destination tags by the source system that sent them?
instructions:
- text: List destination tags from source system {source_system}.
slots:
source_system: query.source_system
- text: Show page {page} of the newest destination tags, {per_page} per page.
slots:
page: query.page
per_page: query.per_page
method: generated
generated: '2026-09-26'
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.