Cisco Identity Services Engine Supportbundle API

openapi: 3.2.0
info:
  title: ISE ERS Supportbundle API
  version: 3.1.0
  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/
servers:
- url: https://{server}:{port}/ers/config
  description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs
  variables:
    server:
      description: The host where the API is rooted
      default: localhost
    port:
      description: The port no for CTS APIs is 9063 and for other APIs it is 443
      default: '443'
security:
- HTTPBasicAuthentication: []
tags:
- name: supportbundle
paths:
  /supportbundle/:
    post:
      tags:
      - supportbundle
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/supportbundle.supportbundle'
            example:
              SupportBundle:
                hostName: sampleHost
                supportBundleIncludeOptions:
                  fromDate: 04/21/2019
                  mntLogs: true
                  includeSystemLogs: true
                  toDate: 04/22/2019
                  policyXml: true
                  includeConfigDB: true
                  includeLocalLogs: true
                  includeDebugLogs: true
                  includeCoreFiles: true
                name: supportBundle
                description: Support Bundle Generation
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
        required: true
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '500':
          description: Internal Server Error
components:
  schemas:
    supportbundle.supportbundle:
      required:
      - SupportBundle
      type: object
      properties:
        SupportBundle:
          $ref: '#/components/schemas/SupportBundle'
      example: null
    SupportBundle:
      required:
      - hostName
      - name
      properties:
        hostName:
          title: hostName
          type: string
          description: This parameter is hostName only, xxxx of xxxx.yyy.zz
          example: null
        supportBundleIncludeOptions:
          required:
          - IncludeConfigDB
          - includeCoreFiles
          - includeDebugLogs
          - includeLocalLogs
          - includeSystemLogs
          - mntLogs
          - policyXml
          properties:
            IncludeConfigDB:
              title: IncludeConfigDB
              type: boolean
              description: Set to include Config DB in Support Bundle
              example: null
            includeDebugLogs:
              title: includeDebugLogs
              type: boolean
              description: Set to include Debug logs in Support Bundle
              example: null
            includeLocalLogs:
              title: includeLocalLogs
              type: boolean
              description: Set to include Local logs in Support Bundle
              example: null
            includeCoreFiles:
              title: includeCoreFiles
              type: boolean
              description: Set to include Core files in Support Bundle
              example: null
            includeSystemLogs:
              title: includeSystemLogs
              type: boolean
              description: Set to include System logs in Support Bundle
              example: null
            mntLogs:
              title: mntLogs
              type: boolean
              description: Set to include Monitoring and troublshooting logs in Support Bundle
              example: null
            policyXml:
              title: policyXml
              type: boolean
              description: Set to include Policy XML in Support Bundle
              example: null
            fromDate:
              title: fromDate
              type: object
              description: Date from where support bundle should include the logs
              example: null
            toDate:
              title: toDate
              type: object
              description: Date upto where support bundle should include the logs
              example: null
          example: null
        name:
          title: name
          type: string
          description: name
          example: null
        id:
          title: id
          type: string
          description: Id
          example: null
        description:
          title: description
          type: string
          description: Description
          example: null
      example:
        SupportBundle:
          hostName: sampleHost
          supportBundleIncludeOptions:
            fromDate: 04/21/2019
            mntLogs: true
            includeSystemLogs: true
            toDate: 04/22/2019
            policyXml: true
            includeConfigDB: true
            includeLocalLogs: true
            includeDebugLogs: true
            includeCoreFiles: true
          name: supportBundle
          description: Support Bundle Generation
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
    ERSResponse:
      type: object
      properties:
        operation:
          type: string
          example: Operation
        messages:
          type: array
          example: null
          items:
            properties:
              title:
                type: string
                example: title
              type:
                type: string
                example: type
              code:
                type: string
                example: code
            example: null
      example: null
  securitySchemes:
    HTTPBasicAuthentication:
      type: http
      scheme: basic