AppDynamics Policies API

openapi: 3.2.0
info:
  title: AppDynamics Alert and Respond Policies 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: Policies
  description: Manage alerting policies that connect health rule violations to automated response actions.
paths:
  /alerting/rest/v1/applications/{applicationId}/policies:
    get:
      operationId: listPolicies
      summary: List policies for an application
      description: Returns all alerting policies configured for the specified application. Policies define which events or health rule violations trigger automated actions.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/applicationId'
      responses:
        '200':
          description: Successful retrieval of policies
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Policy'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Application not found
    post:
      operationId: createPolicy
      summary: Create a policy
      description: Creates a new alerting policy for the specified application with event triggers and associated actions.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/applicationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Policy'
      responses:
        '201':
          description: Policy created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '400':
          description: Bad request - invalid policy configuration
        '401':
          description: Unauthorized - invalid or missing credentials
  /alerting/rest/v1/applications/{applicationId}/policies/{policyId}:
    get:
      operationId: getPolicy
      summary: Get a specific policy
      description: Returns the full configuration for a specific alerting policy.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/policyId'
      responses:
        '200':
          description: Successful retrieval of policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Policy or application not found
    put:
      operationId: updatePolicy
      summary: Update a policy
      description: Updates an existing alerting policy with the provided configuration.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/policyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Policy'
      responses:
        '200':
          description: Policy updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '400':
          description: Bad request - invalid policy configuration
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Policy or application not found
    delete:
      operationId: deletePolicy
      summary: Delete a policy
      description: Deletes the specified alerting policy from the application.
      tags:
      - Policies
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/policyId'
      responses:
        '204':
          description: Policy deleted successfully
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Policy or application not found
components:
  parameters:
    applicationId:
      name: applicationId
      in: path
      required: true
      description: The numeric ID of the business application.
      schema:
        type: integer
        format: int64
    policyId:
      name: policyId
      in: path
      required: true
      description: The numeric ID of the alerting policy.
      schema:
        type: integer
        format: int64
  schemas:
    Policy:
      type: object
      description: An alerting policy that connects health rule violations and events to automated response actions.
      properties:
        id:
          type: integer
          format: int64
          description: The internal numeric identifier for the policy.
        name:
          type: string
          description: The name of the policy.
        enabled:
          type: boolean
          description: Whether the policy is currently enabled.
        executeActionsInBatch:
          type: boolean
          description: Whether to batch action execution.
        actions:
          type: array
          description: The list of action references triggered by this policy.
          items:
            type: object
            properties:
              actionName:
                type: string
                description: The name of the referenced action.
              actionType:
                type: string
                description: The type of the referenced action.
        events:
          type: object
          description: The event filter configuration defining which events trigger this policy.
        selectedEntityType:
          type: string
          description: The type of entity this policy applies to.
  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