AppDynamics Tiers API

openapi: 3.2.0
info:
  title: AppDynamics Controller REST Tiers 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: Tiers
  description: Retrieve tier information for monitored applications including tier names and IDs.
paths:
  /rest/applications/{applicationId}/tiers:
    get:
      operationId: listTiers
      summary: List tiers for an application
      description: Returns all tiers associated with the specified application including tier names, IDs, and related metadata.
      tags:
      - Tiers
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of tier list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tier'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Application not found
  /rest/applications/{applicationId}/tiers/{tierId}:
    get:
      operationId: getTier
      summary: Get a specific tier
      description: Returns details for a specific tier within an application.
      tags:
      - Tiers
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/tierId'
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of tier details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tier'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Tier or application not found
components:
  parameters:
    tierId:
      name: tierId
      in: path
      required: true
      description: The numeric ID or name of the tier.
      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
    applicationId:
      name: applicationId
      in: path
      required: true
      description: The numeric ID or name of the business application.
      schema:
        type: string
  schemas:
    Tier:
      type: object
      description: A tier within a monitored business application representing a logical grouping of nodes.
      properties:
        id:
          type: integer
          format: int64
          description: The internal numeric identifier for the tier.
        name:
          type: string
          description: The name of the tier.
        type:
          type: string
          description: The agent type associated with this tier.
        agentType:
          type: string
          description: The type of agent instrumentation used by the tier.
        numberOfNodes:
          type: integer
          description: The number of nodes belonging to this tier.
  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