AppDynamics Events API

Publish custom analytics events to the Events Service for storage and analysis.

OpenAPI Specification

appdynamics-events-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AppDynamics Alert and Respond Actions Events API
  description: The AppDynamics Alert and Respond API enables programmatic management of health rules, policies, and actions within the AppDynamics Controller. Developers can create, update, and delete health rules that define performance thresholds, configure alerting policies that determine how violations are handled, and set up automated response actions. This API is essential for automating incident response workflows and integrating AppDynamics alerting with external notification and ticketing systems.
  version: 23.x
  contact:
    name: Splunk AppDynamics Support
    url: https://www.appdynamics.com/support
  termsOfService: https://www.cisco.com/c/en/us/about/legal/cloud-and-software.html
servers:
- url: https://{controller-host}/controller
  description: AppDynamics Controller
  variables:
    controller-host:
      default: example.saas.appdynamics.com
      description: The hostname of your AppDynamics Controller instance.
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Events
  description: Publish custom analytics events to the Events Service for storage and analysis.
paths:
  /events/publish/{schemaName}:
    post:
      operationId: publishEvents
      summary: Publish custom analytics events
      description: Publishes one or more custom analytics events to the Events Service under the specified schema name. Events must conform to the schema definition.
      tags:
      - Events
      parameters:
      - $ref: '#/components/parameters/schemaName'
      - $ref: '#/components/parameters/accountName'
      - $ref: '#/components/parameters/apiKey'
      requestBody:
        required: true
        content:
          application/vnd.appd.events+json;v=2:
            schema:
              type: array
              description: An array of event objects conforming to the schema definition.
              items:
                type: object
      responses:
        '200':
          description: Events published successfully
        '400':
          description: Bad request - events do not conform to schema
        '401':
          description: Unauthorized - invalid account name or API key
        '404':
          description: Schema not found
components:
  parameters:
    apiKey:
      name: X-Events-API-Key
      in: header
      required: true
      description: The API key for authenticating with the Events Service.
      schema:
        type: string
    accountName:
      name: X-Events-API-AccountName
      in: header
      required: true
      description: The AppDynamics account name for authentication.
      schema:
        type: string
    schemaName:
      name: schemaName
      in: path
      required: true
      description: The name of the custom event schema.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token obtained from the /controller/api/oauth/access_token endpoint.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using user@account:password format.
externalDocs:
  description: Alert and Respond API Documentation
  url: https://docs.appdynamics.com/appd/23.x/latest/en/extend-appdynamics/appdynamics-apis/alert-and-respond-api