Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Application Performance Monitoring Services API

6 actions 6 updates phrasing extends openapi/acquia-application-performance-monitoring-services-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/environments/{environmentId}/settings/apm'].get
$.paths['/environments/{environmentId}/settings/apm'].put
$.paths['/subscriptions/{subscriptionUuid}/apm'].get
$.paths['/subscriptions/{subscriptionUuid}/apm/{apmType}'].get
$.paths['/subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in'].post

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 Acquia Cloud API Documentation Application Performance Monitoring Services API
  version: 1.0.0
extends: openapi/acquia-application-performance-monitoring-services-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: 5
- target: $.paths['/environments/{environmentId}/settings/apm'].get
  update:
    x-apievangelist-phrasing:
      intent: See APM tools configured on an environment
      effect: read
      questions:
      - Which application performance monitoring tools are hooked up to this environment?
      - Is APM currently turned on for one of my Acquia environments?
      instructions:
      - text: Show the APM services configured for environment {environment}.
        slots:
          environment: path.environmentId
      - text: Check which performance monitoring tool is set up on environment {environment}.
        slots:
          environment: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/settings/apm'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure an APM tool on an environment
      effect: write
      questions:
      - How do I switch on a performance monitoring tool for a single environment?
      - Can I set the license key for the APM tool an environment reports to?
      instructions:
      - text: Set the APM tool on environment {environment} to {type} with status {status}.
        slots:
          environment: path.environmentId
          type: requestBody.type
          status: requestBody.status
      - text: Update the APM license key on environment {environment} to {key}.
        slots:
          environment: path.environmentId
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionUuid}/apm'].get
  update:
    x-apievangelist-phrasing:
      intent: List APM services available to a subscription
      effect: read
      questions:
      - What performance monitoring services come with my subscription?
      - Which APM types can the applications on a subscription use?
      instructions:
      - text: List the APM services associated with subscription {subscription}.
        slots:
          subscription: path.subscriptionUuid
      - text: Show every monitoring service type tied to subscription {subscription}.
        slots:
          subscription: path.subscriptionUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionUuid}/apm/{apmType}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one APM service type on a subscription
      effect: read
      questions:
      - What are the details of a specific APM service on my subscription?
      - Is a particular monitoring service type active for this subscription?
      instructions:
      - text: Get APM service {apm_type} for subscription {subscription}.
        slots:
          apm_type: path.apmType
          subscription: path.subscriptionUuid
      - text: Look up the {apm_type} monitoring setup on subscription {subscription}.
        slots:
          apm_type: path.apmType
          subscription: path.subscriptionUuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Opt a subscription into New Relic Pro APM
      effect: write
      questions:
      - Can I enable a New Relic Pro license for every application on a subscription at once?
      - What does opting a subscription into New Relic APM do with my account details?
      instructions:
      - text: Opt subscription {subscription} into the {apm_type} APM license.
        slots:
          subscription: path.subscriptionUuid
          apm_type: path.apmType
      - text: Enable New Relic Pro APM for all applications on subscription {subscription} using type {apm_type}.
        slots:
          subscription: path.subscriptionUuid
          apm_type: path.apmType
      method: generated
      generated: '2026-09-26'