AppDynamics Connections API

openapi: 3.1.0
info:
  title: AppDynamics Alert and Respond Actions Connections 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: Connections
  description: Manage cloud provider connections for AWS, Azure, and GCP to enable automated cloud monitoring at scale.
paths:
  /v2/connections:
    post:
      operationId: createCloudConnection
      summary: Create a cloud connection
      description: Creates a new cloud provider connection to authenticate and authorize Cisco Cloud Observability with your cloud provider. Supports AWS Role Delegation, AWS Access Key Credentials, Microsoft Azure, and Google Cloud Platform connection types.
      tags:
      - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudConnection'
      responses:
        '201':
          description: Cloud connection created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnection'
        '400':
          description: Bad request - invalid connection configuration
        '401':
          description: Unauthorized - invalid or expired access token
    get:
      operationId: listCloudConnections
      summary: List cloud connections
      description: Returns all cloud provider connections configured for the tenant.
      tags:
      - Connections
      responses:
        '200':
          description: Successful retrieval of cloud connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: Array of cloud connection objects.
                    items:
                      $ref: '#/components/schemas/CloudConnection'
        '401':
          description: Unauthorized - invalid or expired access token
  /v2/connections/{connectionId}:
    get:
      operationId: getCloudConnection
      summary: Get a specific cloud connection
      description: Returns the configuration details for a specific cloud connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionId'
      responses:
        '200':
          description: Successful retrieval of cloud connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnection'
        '401':
          description: Unauthorized - invalid or expired access token
        '404':
          description: Connection not found
    patch:
      operationId: updateCloudConnection
      summary: Update a cloud connection
      description: Partially updates an existing cloud connection configuration.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudConnection'
      responses:
        '200':
          description: Cloud connection updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnection'
        '400':
          description: Bad request - invalid connection update
        '401':
          description: Unauthorized - invalid or expired access token
        '404':
          description: Connection not found
    delete:
      operationId: deleteCloudConnection
      summary: Delete a cloud connection
      description: Deletes the specified cloud connection and stops monitoring the associated cloud resources.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionId'
      responses:
        '204':
          description: Cloud connection deleted successfully
        '401':
          description: Unauthorized - invalid or expired access token
        '404':
          description: Connection not found
components:
  schemas:
    CloudConnection:
      type: object
      description: A cloud provider connection configuration for authenticating and authorizing Cisco Cloud Observability with a cloud provider.
      properties:
        id:
          type: string
          description: The unique identifier of the cloud connection.
        type:
          type: string
          description: The cloud provider type.
          enum:
          - aws
          - azure
          - gcp
        displayName:
          type: string
          description: A human-readable display name for the connection.
        description:
          type: string
          description: An optional description of the cloud connection.
        state:
          type: string
          description: The current state of the connection.
          enum:
          - active
          - inactive
          - error
        details:
          type: object
          description: Provider-specific connection details including credentials and role configuration.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the connection was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the connection was last updated.
  parameters:
    connectionId:
      name: connectionId
      in: path
      required: true
      description: The unique identifier of the cloud connection.
      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