AppDynamics Applications API

openapi: 3.2.0
info:
  title: AppDynamics Controller REST Applications API
  description: The AppDynamics Controller REST API provides programmatic access to the AppDynamics Controller for retrieving application performance data, managing configurations, and automating monitoring workflows. The API uses standard HTTP methods and returns data in XML or JSON format, with the base URI pattern of /controller/rest/. Developers can use it to query application metrics, retrieve transaction snapshots, manage business transactions, and access topology information for monitored applications.
  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: Applications
  description: Retrieve business application names, IDs, and related metadata from the Controller.
paths:
  /rest/applications:
    get:
      operationId: listApplications
      summary: List all business applications
      description: Returns the names and internal numeric identifiers for all business applications visible to the authenticated user. Use this method to discover application names or IDs before invoking other API methods.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of application list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Application'
        '401':
          description: Unauthorized - invalid or missing credentials
        '403':
          description: Forbidden - insufficient permissions
  /rest/applications/{applicationId}:
    get:
      operationId: getApplication
      summary: Get a specific application
      description: Returns the details for a specific business application identified by its numeric ID or name.
      tags:
      - Applications
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of application details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Application not found
components:
  parameters:
    applicationId:
      name: applicationId
      in: path
      required: true
      description: The numeric ID or name of the business application.
      schema:
        type: string
    outputFormat:
      name: output
      in: query
      required: false
      description: The output format for the response. Defaults to XML if not specified.
      schema:
        type: string
        enum:
        - JSON
        - XML
        default: XML
  schemas:
    Application:
      type: object
      description: A business application monitored by the AppDynamics Controller.
      properties:
        id:
          type: integer
          format: int64
          description: The internal numeric identifier for the application.
        name:
          type: string
          description: The name of the business application.
        description:
          type: string
          description: An optional description of the application.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token obtained from the /controller/api/oauth/access_token endpoint using client credentials grant.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Controller username and password in the format user@account:password.
externalDocs:
  description: Using the Controller APIs
  url: https://docs.appdynamics.com/appd/23.x/latest/en/extend-appdynamics/appdynamics-apis/using-the-controller-apis