New Relic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for New Relic Alerts API

36 actions 36 updates phrasing extends openapi/new-relic-alerts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for New Relic's API. It is a proposal applied on top of the contract, not a document New Relic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 36 · first 16 shown; the file carries all of them

$.info
$.paths['/alerts_channels.json'].get
$.paths['/alerts_channels.json'].post
$.paths['/alerts_channels/{channel_id}.json'].delete
$.paths['/alerts_conditions.json'].get
$.paths['/alerts_conditions/policies/{policy_id}.json'].post
$.paths['/alerts_conditions/{condition_id}.json'].put
$.paths['/alerts_conditions/{condition_id}.json'].delete
$.paths['/alerts_entity_conditions/{entity_id}.json'].get
$.paths['/alerts_entity_conditions/{entity_id}.json'].put
$.paths['/alerts_entity_conditions/{entity_id}.json'].delete
$.paths['/alerts_events.json'].get
$.paths['/alerts_external_service_conditions.json'].get
$.paths['/alerts_external_service_conditions/policies/{policy_id}.json'].post
$.paths['/alerts_external_service_conditions/{condition_id}.json'].put
$.paths['/alerts_external_service_conditions/{condition_id}.json'].delete

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 New Relic Alerts API
  version: 1.0.0
extends: openapi/new-relic-alerts-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: 35
- target: $.paths['/alerts_channels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert notification channels
      effect: read
      questions:
      - Which notification channels are set up on my New Relic account?
      - Where do my alert notifications get sent right now?
      instructions:
      - text: List every alert notification channel on my account.
      - text: Show page {page} of my alert notification channels.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_channels.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert notification channel
      effect: write
      questions:
      - How do I add a new place for alert notifications to be sent?
      - Can I attach a new notification channel to existing alert policies when I create it?
      instructions:
      - text: Create a new alert notification channel.
      - text: Create a notification channel and link it to alert policies {policy_ids}.
        slots:
          policy_ids: query.policy_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_channels/{channel_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert notification channel
      effect: destructive
      questions:
      - Can I remove a notification channel I no longer use for alerts?
      - Why can't a user notification channel be deleted?
      instructions:
      - text: Delete alert notification channel {channel_id}.
        slots:
          channel_id: path.channel_id
      - text: Remove the notification channel {channel_id} so alerts stop going there.
        slots:
          channel_id: path.channel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_conditions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List APM, Browser and Mobile metric conditions
      effect: read
      questions:
      - What application metric conditions are in one of my alert policies?
      - Which APM, Browser and Mobile metric thresholds does a policy check?
      instructions:
      - text: List the APM, Browser and Mobile metric conditions in policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Show page {page} of application metric conditions for alert policy {policy_id}.
        slots:
          page: query.page
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_conditions/policies/{policy_id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application metric alert condition
      effect: write
      questions:
      - How do I alert when an APM application's metric crosses a threshold?
      - Can I add a Browser or Mobile app metric condition to an existing policy?
      instructions:
      - text: Add a new APM application metric condition to alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Create a Browser or Mobile metric threshold condition in policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_conditions/{condition_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application metric alert condition
      effect: write
      questions:
      - Can I change the threshold on an existing APM metric alert condition?
      - What happens to an application metric condition when I edit its settings?
      instructions:
      - text: Update application metric condition {condition_id} with new threshold settings.
        slots:
          condition_id: path.condition_id
      - text: Edit the APM, Browser or Mobile metric condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_conditions/{condition_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application metric alert condition
      effect: destructive
      questions:
      - How do I get rid of an APM metric condition that keeps firing for no reason?
      - Can I delete a Browser or Mobile application metric condition from a policy?
      instructions:
      - text: Delete application metric condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Remove the APM metric alert condition {condition_id} from its policy.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_entity_conditions/{entity_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the alert conditions an entity belongs to
      effect: read
      questions:
      - Which alert conditions is a particular application or server part of?
      - What conditions are watching one of my Browser or Mobile apps?
      instructions:
      - text: Show which alert conditions {entity_type} entity {entity_id} is part of.
        slots:
          entity_type: query.entity_type
          entity_id: path.entity_id
      - text: List the conditions covering application {entity_id} of type {entity_type}.
        slots:
          entity_id: path.entity_id
          entity_type: query.entity_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_entity_conditions/{entity_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an entity to an alert condition
      effect: write
      questions:
      - How do I make an existing alert condition also cover another application?
      - Can I add a server or key transaction to a condition that's already defined?
      instructions:
      - text: Add {entity_type} entity {entity_id} to alert condition {condition_id}.
        slots:
          entity_type: query.entity_type
          entity_id: path.entity_id
          condition_id: query.condition_id
      - text: Start monitoring entity {entity_id} ({entity_type}) under condition {condition_id}.
        slots:
          entity_id: path.entity_id
          entity_type: query.entity_type
          condition_id: query.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_entity_conditions/{entity_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an entity from an alert condition
      effect: destructive
      questions:
      - How do I stop one application from being covered by an alert condition without deleting the condition?
      - Can I detach a server from a condition it's currently part of?
      instructions:
      - text: Remove {entity_type} entity {entity_id} from alert condition {condition_id}.
        slots:
          entity_type: query.entity_type
          entity_id: path.entity_id
          condition_id: query.condition_id
      - text: Disassociate entity {entity_id} of type {entity_type} from condition {condition_id}.
        slots:
          entity_id: path.entity_id
          entity_type: query.entity_type
          condition_id: query.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert events
      effect: read
      questions:
      - What alert events has my account recorded recently?
      - Can I filter alert events by product, like only Synthetics or only APM?
      - Which alert events belong to a specific incident?
      instructions:
      - text: List alert events for product {product}.
        slots:
          product: query.filter[product]
      - text: Show the alert events tied to incident {incident_id}.
        slots:
          incident_id: query.filter[incident_id]
      - text: List alert events of type {event_type} for entity {entity_id}.
        slots:
          event_type: query.filter[event_type]
          entity_id: query.filter[entity_id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_external_service_conditions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List external service alert conditions
      effect: read
      questions:
      - Which external service conditions does one of my alert policies have?
      - Am I alerting on slow calls to third-party services my app depends on?
      instructions:
      - text: List the external service conditions in alert policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Show page {page} of external service conditions for policy {policy_id}.
        slots:
          page: query.page
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_external_service_conditions/policies/{policy_id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an external service alert condition
      effect: write
      questions:
      - How do I get alerted when an external service my app calls gets slow?
      - Can I add an external service condition to an existing alert policy?
      instructions:
      - text: Create an external service condition in alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Add a condition watching external service calls to policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_external_service_conditions/{condition_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external service alert condition
      effect: write
      questions:
      - Can I change the threshold of an external service condition I already created?
      - What fields can I edit on an existing external service alert condition?
      instructions:
      - text: Update external service condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Change the settings of the external service alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_external_service_conditions/{condition_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external service alert condition
      effect: destructive
      questions:
      - How do I remove an external service condition from my alert policy?
      - Can I stop alerting on a third-party service call that no longer matters?
      instructions:
      - text: Delete external service condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Remove the external service alert condition {condition_id} from its policy.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_incidents.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert incidents
      effect: read
      questions:
      - What alert incidents have been opened on my New Relic account?
      - Can I see only the incidents that are still open?
      instructions:
      - text: List all alert incidents on my account.
      - text: Show only open alert incidents, filter set to {only_open}.
        slots:
          only_open: query.only_open
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_location_failure_conditions/policies/{policy_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List location failure conditions for a policy
      effect: read
      questions:
      - Which location failure conditions are defined in one of my alert policies?
      - Am I alerting when a monitor fails from several locations at once?
      instructions:
      - text: List the location failure conditions in alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Show page {page} of location failure conditions for policy {policy_id}.
        slots:
          page: query.page
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_location_failure_conditions/policies/{policy_id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a location failure alert condition
      effect: write
      questions:
      - How do I set up an alert for when a check fails across multiple locations?
      - Can I add a location failure condition to an existing alert policy?
      instructions:
      - text: Create location failure condition {location_failure_condition} in alert policy {policy_id}.
        slots:
          location_failure_condition: path.location_failure_condition
          policy_id: path.policy_id
      - text: Add a multi-location failure condition {location_failure_condition} to policy {policy_id}.
        slots:
          location_failure_condition: path.location_failure_condition
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_location_failure_conditions/{condition_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a location failure alert condition
      effect: write
      questions:
      - Can I change which locations or thresholds a location failure condition uses?
      - What can I edit on a location failure condition after creating it?
      instructions:
      - text: Update location failure condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Edit the settings of the location failure alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_location_failure_conditions/{condition_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a location failure alert condition
      effect: destructive
      questions:
      - How do I remove a location failure condition from my policy?
      - Can I delete a multi-location failure alert I don't need anymore?
      instructions:
      - text: Delete location failure condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Remove the location failure alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_nrql_conditions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List NRQL alert conditions for a policy
      effect: read
      questions:
      - Which NRQL query-based conditions are in one of my alert policies?
      - What NRQL queries is a policy alerting on?
      instructions:
      - text: List the NRQL conditions in alert policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Show page {page} of NRQL alert conditions for policy {policy_id}.
        slots:
          page: query.page
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_nrql_conditions/policies/{policy_id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a NRQL alert condition
      effect: write
      questions:
      - How do I create an alert based on a NRQL query?
      - Can I add a NRQL condition to an alert policy I already have?
      instructions:
      - text: Create a NRQL alert condition in policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Add a query-based NRQL condition to alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_nrql_conditions/{condition_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a NRQL alert condition
      effect: write
      questions:
      - Can I change the NRQL query behind an existing alert condition?
      - What happens when I adjust the threshold on a NRQL condition?
      instructions:
      - text: Update NRQL condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Change the query or threshold of NRQL alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_nrql_conditions/{condition_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a NRQL alert condition
      effect: destructive
      questions:
      - How do I delete a NRQL alert condition?
      - Can I remove a query-based condition from a policy without touching its other conditions?
      instructions:
      - text: Delete NRQL condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Remove the NRQL alert condition {condition_id} from its policy.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policies.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert policies
      effect: read
      questions:
      - What alert policies exist on my New Relic account?
      - Can I look up an alert policy by its exact name?
      instructions:
      - text: List all my alert policies.
      - text: Find the alert policy named {name}.
        slots:
          name: query.filter[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policies.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert policy
      effect: write
      questions:
      - How do I create a new alert policy?
      - Can I pick a per-policy or per-condition incident rollup when creating a policy?
      instructions:
      - text: Create a new alert policy.
      - text: Create an alert policy that opens one incident per condition.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policies/{policy_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert policy
      effect: write
      questions:
      - Can I rename an alert policy or change its incident rollup?
      - What settings of an existing alert policy can be updated?
      instructions:
      - text: Update alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Rename or change the incident preference of policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policies/{policy_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert policy
      effect: destructive
      questions:
      - How do I delete an alert policy entirely?
      - Does an Admin User's API key need to be used to remove a policy?
      instructions:
      - text: Delete alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Remove the whole alert policy {policy_id} from my account.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policy_channels.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Link notification channels to an alert policy
      effect: write
      questions:
      - How do I make an alert policy notify a channel I already created?
      - Can I attach several notification channels to one policy at once?
      instructions:
      - text: Link channels {channel_ids} to alert policy {policy_id}.
        slots:
          channel_ids: query.channel_ids
          policy_id: query.policy_id
      - text: Send alerts from policy {policy_id} to notification channels {channel_ids}.
        slots:
          policy_id: query.policy_id
          channel_ids: query.channel_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_policy_channels.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a notification channel from a policy
      effect: destructive
      questions:
      - How do I stop a policy from notifying one channel without deleting the channel?
      - Can I detach a single notification channel from an alert policy?
      instructions:
      - text: Unlink channel {channel_id} from alert policy {policy_id}.
        slots:
          channel_id: query.channel_id
          policy_id: query.policy_id
      - text: Stop policy {policy_id} from sending alerts to channel {channel_id}.
        slots:
          policy_id: query.policy_id
          channel_id: query.channel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_synthetics_conditions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Synthetics alert conditions
      effect: read
      questions:
      - Which Synthetics monitor conditions are in one of my alert policies?
      - Am I alerting on my synthetic monitors failing?
      instructions:
      - text: List the Synthetics conditions in alert policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Show page {page} of Synthetics alert conditions for policy {policy_id}.
        slots:
          page: query.page
          policy_id: query.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_synthetics_conditions/policies/{policy_id}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Synthetics alert condition
      effect: write
      questions:
      - How do I alert when a synthetic monitor fails?
      - Can I add a Synthetics monitor condition to an existing policy?
      instructions:
      - text: Create a Synthetics condition in alert policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Add a synthetic monitor failure condition to policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_synthetics_conditions/{condition_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Synthetics alert condition
      effect: write
      questions:
      - Can I point an existing Synthetics condition at a different monitor?
      - What can I change on a Synthetics alert condition after it's created?
      instructions:
      - text: Update Synthetics condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Edit the synthetic monitor alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_synthetics_conditions/{condition_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Synthetics alert condition
      effect: destructive
      questions:
      - How do I remove a Synthetics condition from my alert policy?
      - Can I stop alerting on a synthetic monitor I've retired?
      instructions:
      - text: Delete Synthetics condition {condition_id}.
        slots:
          condition_id: path.condition_id
      - text: Remove the synthetic monitor alert condition {condition_id}.
        slots:
          condition_id: path.condition_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/alerts_violations.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert violations
      effect: read
      questions:
      - What alert violations happened on my account last week?
      - Can I see only the violations that are still open?
      - Which violations were created between two dates?
      instructions:
      - text: List alert violations created between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show open alert violations only, filter set to {only_open}.
        slots:
          only_open: query.only_open
      - text: List all alert violations on my account.
      method: generated
      generated: '2026-10-01'