AppDynamics Custom Dashboards Export/Import API

Export and import custom dashboard configurations.

OpenAPI Specification

appdynamics-custom-dashboards-export-import-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AppDynamics Alert and Respond Actions Custom Dashboards Export/Import 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: Custom Dashboards Export/Import
  description: Export and import custom dashboard configurations.
paths:
  /CustomDashboardImportExportServlet:
    get:
      operationId: exportCustomDashboard
      summary: Export a custom dashboard
      description: Exports a custom dashboard configuration as a JSON document for backup or migration to another Controller instance.
      tags:
      - Custom Dashboards Export/Import
      parameters:
      - name: dashboardId
        in: query
        required: true
        description: The numeric ID of the custom dashboard to export.
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful export of dashboard configuration
          content:
            application/json:
              schema:
                type: object
                description: JSON representation of the dashboard configuration.
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Dashboard not found
    post:
      operationId: importCustomDashboard
      summary: Import a custom dashboard
      description: Imports a custom dashboard configuration from a JSON file into the Controller.
      tags:
      - Custom Dashboards Export/Import
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The JSON file containing the dashboard configuration to import.
      responses:
        '200':
          description: Dashboard imported successfully
        '400':
          description: Bad request - invalid dashboard configuration
        '401':
          description: Unauthorized - invalid or missing credentials
components:
  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