AppDynamics Nodes API

openapi: 3.2.0
info:
  title: AppDynamics Controller REST Nodes 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: Nodes
  description: Retrieve node information for monitored applications including node names, IDs, machine details, and agent versions.
paths:
  /rest/applications/{applicationId}/nodes:
    get:
      operationId: listNodes
      summary: List nodes for an application
      description: Returns all nodes associated with the specified application including node names, IDs, machine details, IP addresses, and agent version information.
      tags:
      - Nodes
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of node list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Node'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Application not found
  /rest/applications/{applicationId}/tiers/{tierId}/nodes:
    get:
      operationId: listTierNodes
      summary: List nodes for a specific tier
      description: Returns all nodes belonging to a specific tier within an application.
      tags:
      - Nodes
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - $ref: '#/components/parameters/tierId'
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of tier node list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Node'
        '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:
    Node:
      type: object
      description: A node within a tier representing a single application instance or JVM/CLR process.
      properties:
        id:
          type: integer
          format: int64
          description: The internal numeric identifier for the node.
        name:
          type: string
          description: The name of the node.
        type:
          type: string
          description: The agent type associated with this node.
        tierId:
          type: integer
          format: int64
          description: The numeric ID of the tier this node belongs to.
        tierName:
          type: string
          description: The name of the tier this node belongs to.
        machineId:
          type: integer
          format: int64
          description: The numeric ID of the machine hosting this node.
        machineName:
          type: string
          description: The name of the machine hosting this node.
        machineOSType:
          type: string
          description: The operating system type of the host machine.
        ipAddresses:
          type: object
          description: The IP addresses associated with this node.
        agentType:
          type: string
          description: The type of agent instrumentation used by the node.
        appAgentVersion:
          type: string
          description: The version of the application agent running on this node.
        machineAgentVersion:
          type: string
          description: The version of the machine agent running on the host.
  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