Generated by API Evangelist
Written by API Evangelist tooling for Tenable's API. It is a proposal applied on top of the contract, not a document Tenable publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Identity Exposure Alert API
version: 1.0.0
extends: openapi/tenable-alert-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/api/alerts/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an alert
effect: read
questions:
- How do I open the details of a single alert?
- Can I check whether a specific alert has been read or archived?
instructions:
- text: Get alert {id}.
slots:
id: path.id
- text: Show the details of alert {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/alerts/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Mark one alert read or archived
effect: write
questions:
- Can I mark just one alert as read?
- How do I archive a single alert I've dealt with?
instructions:
- text: Set archived to {archived} on alert {id}.
slots:
id: path.id
archived: requestBody.archived
- text: 'Mark alert {id} as read: {read}.'
slots:
id: path.id
read: requestBody.read
method: generated
generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/alerts'].get
update:
x-apievangelist-phrasing:
intent: List alerts for a profile
effect: read
questions:
- What alerts are open for my security profile?
- Can I list only unread alerts, or only archived ones?
instructions:
- text: List alerts for profile {profileId}.
slots:
profileId: path.profileId
- text: Show unread alerts in profile {profileId}, read={read}, archived={archived}.
slots:
profileId: path.profileId
read: query.read
archived: query.archived
method: generated
generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/alerts'].patch
update:
x-apievangelist-phrasing:
intent: Bulk-mark a profile's alerts
effect: write
questions:
- How do I mark every alert in a profile as read at once?
- Is there a way to archive all alerts for a profile in bulk?
instructions:
- text: Mark all alerts in profile {profileId} as read={read}.
slots:
profileId: path.profileId
read: requestBody.read
- text: Bulk set archived={archived} on every alert of profile {profileId}.
slots:
profileId: path.profileId
archived: requestBody.archived
method: generated
generated: '2026-10-01'
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.