Cisco Identity Services Engine Supportbundletriggerconfiguration API

openapi: 3.2.0
info:
  description: "Support Bundle Trigger API allows clients to trigger support bundle provided the log settings are given using which the support needs to be generated.\n\n\n<h2>Revision History</h2>\n<table font-family:monospace> \n<tr valign=top style='border:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt;background:#DEEDF7'><td><b>Revision #</b></td><td><b>Resource Version</b></td><td><b>Cisco ISE Version</b></td><td><b>Description</b></td></tr>\n<tr style='border-bottom:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt'><td>0</td><td>1.0</td><td>2.7</td><td>Initial Cisco ISE Version</td><td></td><td></td></tr>\n</table>\n<br><br>\n\n<h2>Resource Definition</h2>\n<table>\n<tr valign=top style='border:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt;background:#DEEDF7'><td><b>Attribute</b></td><td><b>Type</b></td><td><b>Required</b></td><td><b>Description</b></td><td><b>Default Values</b></td><td><b>Example Values</b></td></tr>\n<tr><td style='font-family:monospace'>name</td><td>String</td><td>Yes</td><td>Resource Name</td><td>supportBundle</td></tr>\n<tr valign=top style='background:#f8f8f8'><td style='font-family:monospace'>id</td><td>String</td><td>No</td><td>Resource UUID, mandatory for update</td><td></td><td>1af3d6e2-cc3b-4603-b80f-6827768335ab</td></tr>\n<tr><td style='font-family:monospace'>description</td><td>String</td><td>No</td><td>Resource Description</td><td></td><td>Support Bundle Generation</td></tr>\n<tr valign=top style='background:#f8f8f8'><td style='font-family:monospace'>hostName</td><td>String</td><td>Yes</td><td>This parameter is hostName only, xxxx of xxxx.yyy.zz</td><td></td></td><td>sampleHost</td></tr>\n<tr><td style='font-family:monospace'>supportBundleOptions</td><td>List</td><td>Yes</td><td></td><td></td><td></td></tr> \n<tr><td style='font-family:monospace'>- includeConfigDB</td><td>Boolean</td><td>Yes</td><td>Set to include Config DB in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- includeDebugLogs</td><td>Boolean</td><td>Yes</td><td>Set to include Debug logs in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- includeLocalLogs</td><td>Boolean</td><td>Yes</td><td>Set to include Local logs in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- includeCoreFiles</td><td>Boolean</td><td>Yes</td><td>Set to include Core files in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- includeSystemLogs</td><td>Boolean</td><td>Yes</td><td>Set to include System logs in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- mntLogs</td><td>Boolean</td><td>Yes</td><td>Set to include Monitoring and troublshooting logs in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- policyXml</td><td>Boolean</td><td>Yes</td><td>Set to include Policy XML in Support Bundle</td><td>false</td><td></td></tr>\n<tr><td style='font-family:monospace'>- fromDate</td><td>Date</td><td>No</td><td>Date from where support bundle should include the logs</td><td></td><td>04/21/2019</td></tr>\n<tr style='border-bottom:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt'><td style='font-family:monospace'>- toDate</td><td>Date</td><td>No</td><td>Date upto where support bundle should include the logs</td><td></td><td>04/22/2019</td></tr>\n</table>\n"
  version: 1.0.0
  title: Support Bundle Trigger Configuration Supportbundletriggerconfiguration API
  x-provenance:
    method: harvested
    authored_by: Cisco
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 103 ISE API descriptions (1,490 operations; 32 OpenAPI 3.0.x + 71 Swagger 2.0) enumerated from Cisco's own DevNet project manifest and fetched anonymously. Byte-identity reconfirmed 2026-08-19 by SHA-256 against the live source.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/identity-services-engine-api-v1/docs/
  - type: source
    url: https://developer.cisco.com/docs/identity-services-engine/
tags:
- name: supportbundletriggerconfiguration
paths:
  /ers/config/supportbundle:
    post:
      tags:
      - supportbundletriggerconfiguration
      summary: Create support bundle trigger configuration
      description: <p>This API allows the client to create a support bundle trigger configuration.</p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- supportbundle.supportbundle.1.0
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: Required Only if Enabled from GUI Example:- fetch
        schema:
          type: string
      responses:
        201:
          description: Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/supportbundletriggerconfiguration'
          application/xml:
            schema:
              $ref: '#/components/schemas/supportbundletriggerconfiguration'
  /ers/config/supportbundle/versioninfo:
    get:
      tags:
      - supportbundletriggerconfiguration
      summary: Get support bundle trigger configuration version information
      description: <p>This API helps to retrieve the version information related to the support bundle trigger configuration.</p>
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionInfo'
components:
  schemas:
    supportbundletriggerconfiguration:
      type: object
      properties:
        SupportBundle:
          $ref: '#/components/schemas/SupportBundle'
    VersionInfo:
      type: object
      properties:
        VersionInfo:
          $ref: '#/components/schemas/version'
    SupportBundle:
      type: object
      properties:
        name:
          type: string
          example: supportBundle
        description:
          type: string
          example: Support Bundle Generation
        hostName:
          type: string
          example: sampleHost
        supportBundleIncludeOptions:
          type: object
          properties:
            includeConfigDB:
              type: boolean
              example: true
            includeDebugLogs:
              type: boolean
              example: true
            includeLocalLogs:
              type: boolean
              example: true
            includeCoreFiles:
              type: boolean
              example: true
            mntLogs:
              type: boolean
              example: true
            includeSystemLogs:
              type: boolean
              example: true
            policyXml:
              type: boolean
              example: true
            fromDate:
              type: string
              example: 04/21/2019
            toDate:
              type: string
              example: 04/22/2019
    version:
      type: object
      properties:
        currentServerVersion:
          type: string
          example: '1.0'
        supportedVersions:
          type: string
          example: '1.0'
        link:
          $ref: '#/components/schemas/link1'
    link1:
      type: object
      properties:
        rel:
          type: string
          example: self
        href:
          type: string
          example: https://<ise-ip>:9060/ers/config/supportbundle/versioninfo
        type:
          type: string
          example: application/json