openapi: 3.0.3
info:
  title: Cisco ISE API - System Settings
  version: 1.0.0
servers:
  - url: https://10.56.60.25:443
    description: Inferred Url
tags:
  - name: system-settings-api-controller
    description: the system-settings API
paths:
  /api/v1/system-settings/proxy:
    get:
      tags:
        - proxy
      summary: Returns ISE proxy connection settings
      description: '<p style="font-size: 14px;">The following functionalities are impacted by the proxy settings: </p>                        <ul style="font-size: 14px;">                          <li>Partner Mobile Management</li>                          <li>Endpoint Profiler Feed Service Update</li>                          <li>Endpoint Posture Update</li>                          <li>Endpoint Posture Agent Resources Download</li>                          <li>CRL (Certificate Revocation List) Download</li>                          <li>SMS Message Transmission</li>                          <li>Social Login</li>                          <li>Rest Auth Service - Azure AD</li>                          <li>pxGrid Cloud</li>                        </ul> '
      operationId: getProxyConnection
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return to the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: Proxy Connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyConnectionSettingsResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
        - BasicAuth: []
    put:
      tags:
        - proxy
      summary: Configure ISE proxy connection settings
      description: '<p style="font-size: 14px;">The following functionalities are impacted by the proxy settings: </p>                        <ul style="font-size: 14px;">                          <li>Partner Mobile Management</li>                          <li>Endpoint Profiler Feed Service Update</li>                          <li>Endpoint Posture Update</li>                          <li>Endpoint Posture Agent Resources Download</li>                          <li>CRL (Certificate Revocation List) Download</li>                          <li>SMS Message Transmission</li>                          <li>Social Login</li>                          <li>Rest Auth Service - Azure AD</li>                          <li>pxGrid Cloud</li>                        </ul> '
      operationId: updateProxyConnection
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return to the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyConnectionSettings'
              exampleSetFlag: false
      responses:
        '200':
          description: Proxy Connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyConnectionSettingsResponseEntity'
                exampleSetFlag: false
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
        - BasicAuth: []
  /api/v1/system-settings/telemetry/transport-gateway:
    get:
      tags:
        - telemetry
      summary: Returns ISE transport gateway settings
      description: Transport Gateway acts a proxy for the communication between the ISE servers in your network and the Telemetry servers in case of air-gapped network. <br> **This API is deprecated. Transport Gateway is no longer supported in Cisco ISE.**
      operationId: getTransportGateway
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return to the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      responses:
        '200':
          description: Transport Gateway response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransportGatewaySettingsResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
        - BasicAuth: []
    put:
      tags:
        - telemetry
      summary: Configure ISE transport gateway settings
      description: Transport Gateway acts a proxy for the communication between the ISE servers in your network and the Telemetry servers in case of air-gapped network. <br> **This API is deprecated. Transport Gateway is no longer supported in Cisco ISE.**
      operationId: updateTransportGateway
      parameters:
        - name: X-Request-ID
          in: header
          description: request Id, will return to the response headers, and appear in logs
          required: false
          schema:
            type: string
            exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransportGatewaySettings'
              exampleSetFlag: false
      responses:
        '200':
          description: Transport Gateway response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransportGatewaySettingsResponseEntity'
                exampleSetFlag: false
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
        - BasicAuth: []
components:
  schemas:
    Error:
      title: Error
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          example: '400'
          exampleSetFlag: true
        message:
          type: string
          example: An error message
          exampleSetFlag: true
      exampleSetFlag: false
    ProxyConnectionSettings:
      title: ProxyConnectionSettings
      type: object
      properties:
        bypassHosts:
          type: string
          description: Bypass hosts for the proxy connection
          example: bypassHost1.domain.com,bypassHost2.domain.com
          exampleSetFlag: true
        fqdn:
          type: string
          description: proxy IP address or DNS-resolvable host name
          example: connection.xx
          exampleSetFlag: true
        password:
          type: string
          description: Password for the proxy connection
          example: password
          exampleSetFlag: true
        passwordRequired:
          type: boolean
          description: Indicates whether password configuration is required for Proxy.
          example: true
          exampleSetFlag: true
        port:
          type: integer
          description: Port for proxy connection. should be between 1 and 65535
          format: int32
          example: 1001
          exampleSetFlag: true
        userName:
          type: string
          description: User name for the proxy connection
          example: username
          exampleSetFlag: true
      description: ISE Proxy connection settings
      exampleSetFlag: false
    ProxyConnectionSettingsResponseEntity:
      title: ProxyConnectionSettingsResponseEntity
      required:
        - response
        - version
      type: object
      properties:
        response:
          $ref: '#/components/schemas/ProxyConnectionSettings'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      exampleSetFlag: false
    TransportGatewaySettings:
      title: TransportGatewaySettings
      required:
        - enableTransportGateway
        - url
      type: object
      properties:
        enableTransportGateway:
          type: boolean
          description: Indicates whether transport gateway is enabled or not.
          example: true
          exampleSetFlag: true
        url:
          type: string
          description: URL of transport gateway
          format: uri
          example: http://gateway.xx
          exampleSetFlag: true
      description: Transport Gateway acts a proxy for the communication between the ISE servers in your network and the Telemetry servers in case of air-gapped network.<br> **Transport Gateway is no longer supported in Cisco ISE.**
      exampleSetFlag: false
    TransportGatewaySettingsResponseEntity:
      title: TransportGatewaySettingsResponseEntity
      required:
        - response
        - version
      type: object
      properties:
        response:
          $ref: '#/components/schemas/TransportGatewaySettings'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      exampleSetFlag: false
