Cisco Identity Services Engine Outbound Rule API

openapi: 3.2.0
info:
  title: Cisco ISE API - TrustSec Outbound Rule API
  version: 1.0.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://172.23.118.207:443
  description: Inferred Url
tags:
- name: Outbound Rule
paths:
  /api/v1/trustsec/outbound-rule:
    get:
      tags:
      - Outbound Rule
      summary: Outbound Rule list
      operationId: getEgressFilterList
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Outbound Rule list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressFilterSummaryResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Outbound Rule
      summary: Outbound Rule - Create Outbound Rule.
      description: 'Outbound Rule - Create Outbound Rule: <ul> <li> Filter configuration must include name and condition. </li> <li> Condition has hierarchical structure which define a set of conditions for which authoriztion policy rule could be match. </li> <li> Condition can be either reference to a stored Library condition, using model <b>ConditionReference</b> </li> or dynamically built conditions which are not stored in the conditions Library, using models <b>ConditionAttributes, ConditionAndBlock, ConditionOrBlock</b>. </li> </ul> '
      operationId: createEgressFilter
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EgressFilter'
              exampleSetFlag: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressFilterResponse'
                exampleSetFlag: false
        '201':
          description: ACI Connection information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressFilterResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
  /api/v1/trustsec/outbound-rule/batch:
    post:
      tags:
      - Outbound Rule
      summary: Outbound Rule batch configuration
      operationId: batchConfigureEgressFilter
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EgressFilterBatch'
              exampleSetFlag: false
      responses:
        '200':
          description: Batch update successful
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/outbound-rule/preview:
    post:
      tags:
      - Outbound Rule
      summary: Outbound Rule preview data
      description: Get Inbound Rule preview data
      operationId: getEgressFilterPreview
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundRuleWithPage'
              exampleSetFlag: false
      responses:
        '200':
          description: list of OutboundRulePreviewResponseEntity objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressFilterPreviewResponseEntity'
                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: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
  /api/v1/trustsec/outbound-rule/{filterId}:
    get:
      tags:
      - Outbound Rule
      summary: Outbound Rule - Get Outbound Rule attributes.
      description: Outbound Rule - Get Outbound Rule attributes.
      operationId: getEgressFilterById
      parameters:
      - name: filterId
        in: path
        description: Inbound / Outbound Rule id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Outbound Rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EgressFilterResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Outbound Rule
      summary: Outbound Rule - Update Outbound Rule.
      description: Outbound Rule - Update Outbound Rule.
      operationId: updateEgressFilterById
      parameters:
      - name: filterId
        in: path
        description: Inbound / Outbound Rule id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EgressFilter'
              exampleSetFlag: false
      responses:
        '200':
          description: Update successful
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
      - Outbound Rule
      summary: Outbound Rule - Delete Outbound Rule.
      description: Outbound Rule - Delete Outbound Rule.
      operationId: deleteEgressFilterById
      parameters:
      - name: filterId
        in: path
        description: Inbound / Outbound Rule id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Delete successful
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
components:
  schemas:
    Link:
      title: Link
      required:
      - href
      type: object
      properties:
        href:
          type: string
          example: https://{{ISE_IP}}/api/v1/policy/{{protocol}}/policy-set/{{resource-id}}
          exampleSetFlag: true
        rel:
          type: string
          example: self
          exampleSetFlag: true
          enum:
          - next
          - previous
          - self
          - status
        type:
          type: string
          example: application/json
          exampleSetFlag: true
      exampleSetFlag: false
    RuleCommon:
      title: RuleCommon
      required:
      - name
      type: object
      properties:
        condition:
          $ref: '#/components/schemas/Condition'
          exampleSetFlag: true
        default:
          type: boolean
          description: Indicates if this rule is the default one
          example: false
          exampleSetFlag: true
        hitCounts:
          type: integer
          description: The amount of times the rule was matched
          format: int32
          readOnly: true
          example: 2
          exampleSetFlag: true
        id:
          type: string
          description: The identifier of the rule
          format: uuid
          readOnly: true
          example: d82952cb-b901-4b09-b363-5ebf39bdbaf9
          exampleSetFlag: true
        name:
          type: string
          description: Rule name, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses]
          example: MyRuleName_1
          exampleSetFlag: true
        rank:
          type: integer
          description: The rank(priority) in relation to other rules. Lower rank is higher priority.
          format: int32
          example: 1
          exampleSetFlag: true
        state:
          type: string
          description: The state that the rule is in. A disabled rule cannot be matched.
          example: enabled
          exampleSetFlag: true
          enum:
          - disabled
          - enabled
          - monitor
      description: Common attributes in rule authentication/authorization
      exampleSetFlag: false
    EgressFilterPreviewResponseEntity:
      title: EgressFilterPreviewResponseEntity
      required:
      - response
      - version
      type: object
      properties:
        response:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/EgressFilterPreview'
            exampleSetFlag: false
        version:
          type: string
          exampleSetFlag: true
      exampleSetFlag: false
    EgressFilterPreview:
      title: EgressFilterPreview
      type: object
      properties:
        ipAddress:
          type: string
          exampleSetFlag: true
        learnedBy:
          type: string
          exampleSetFlag: true
        learnedFrom:
          type: array
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        matchingRules:
          type: array
          description: matching rules used in the inbound rule destination configurations
          example: '["Rule1","Rule2"]'
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        primarySgt:
          type: string
          description: Primary SGT name used in the Outbound Rule
          exampleSetFlag: true
        sgtDomains:
          type: array
          description: Sxp Domains used in the inbound rule destination configurations
          example: '["sxpDomain1","sxpDomain2"]'
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        vn:
          type: string
          exampleSetFlag: true
      description: Outbound Rule Preview details
      exampleSetFlag: false
    OutboundRuleContract:
      title: OutboundRuleContract
      required:
      - connectionName
      - l3out
      - sgt
      - tn
      type: object
      properties:
        connectionName:
          type: string
          example: ACI1
          exampleSetFlag: true
        consumed:
          $ref: '#/components/schemas/Consumed'
          exampleSetFlag: true
        l3out:
          type: string
          example: out1
          exampleSetFlag: true
        provided:
          $ref: '#/components/schemas/Provided'
          exampleSetFlag: true
        sgt:
          type: string
          example: sgt1
          exampleSetFlag: true
        tn:
          type: string
          example: tn1
          exampleSetFlag: true
      exampleSetFlag: false
    EgressFilterDestination:
      title: EgressFilterDestination
      type: object
      properties:
        l3outs:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/L3Out'
            exampleSetFlag: false
        name:
          type: string
          example: ACI1
          exampleSetFlag: true
        type:
          type: string
          exampleSetFlag: true
          enum:
          - ACI
          - SXP_SPEAKER
      description: Destinations mapped to l3outs used in the outbound rule destination configurations
      exampleSetFlag: false
    OutboundRuleWithPage:
      title: OutboundRuleWithPage
      type: object
      properties:
        PageNumber:
          type: integer
          description: Page Number
          format: int32
          example: 0
          exampleSetFlag: true
        PageSize:
          type: integer
          description: Page Size
          format: int32
          example: 50000
          exampleSetFlag: true
        nameBeforeEdit:
          type: string
          description: Name of the rule before edit
          example: rule1
          exampleSetFlag: true
        outboundRule:
          $ref: '#/components/schemas/EgressFilter'
          exampleSetFlag: true
      description: Outbound Rule details with Page Info
      exampleSetFlag: false
    EgressFilterResponse:
      title: EgressFilterResponse
      type: object
      properties:
        response:
          $ref: '#/components/schemas/EgressFilter'
          exampleSetFlag: true
        version:
          type: string
          exampleSetFlag: true
      exampleSetFlag: false
    Error:
      title: Error
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          format: int32
          example: 400
          exampleSetFlag: true
        message:
          type: string
          example: Some error occurred
          exampleSetFlag: true
      exampleSetFlag: false
    EgressFilterSummaryResponse:
      title: EgressFilterSummaryResponse
      type: object
      properties:
        response:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/EgressFilter'
            exampleSetFlag: false
        version:
          type: string
          exampleSetFlag: true
      exampleSetFlag: false
    Condition:
      title: Condition
      required:
      - conditionType
      type: object
      properties:
        conditionType:
          type: string
          description: <ul><li>Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation</li> <li>Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both</li> <li>Logical aggreation(and,or) enum indicates that additional conditions are present under the children field</li></ul>
          example: ConditionAttributes
          exampleSetFlag: true
          enum:
          - ConditionAndBlock
          - ConditionAttributes
          - ConditionOrBlock
          - ConditionReference
          - LibraryConditionAndBlock
          - LibraryConditionAttributes
          - LibraryConditionOrBlock
          - TimeAndDateCondition
        isNegate:
          type: boolean
          description: Indicates whereas this condition is in negate mode
          example: false
          exampleSetFlag: true
        link:
          $ref: '#/components/schemas/Link'
          exampleSetFlag: true
      description: <ul><li>Hierarchical structure which defines a set of conditions for which authentication or authorization policy rules could be matched.</li> <li>Logical operations(AND, OR) relationship between conditions are supported</li> <li>Each condition can have subconditions with relation to logical operations</li></ul>
      exampleSetFlag: false
    L3Out:
      title: L3Out
      type: object
      properties:
        l3out:
          type: string
          example: l3out1
          exampleSetFlag: true
        tn:
          type: string
          example: tenant1
          exampleSetFlag: true
        vn:
          type: string
          example: vn1
          exampleSetFlag: true
      exampleSetFlag: false
    EgressFilter:
      title: EgressFilter
      type: object
      properties:
        contracts:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/OutboundRuleContract'
            exampleSetFlag: false
        destinations:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/EgressFilterDestination'
            exampleSetFlag: false
        enabled:
          type: boolean
          example: false
          exampleSetFlag: true
        id:
          type: string
          readOnly: true
          exampleSetFlag: true
        link:
          $ref: '#/components/schemas/Link'
          exampleSetFlag: true
        name:
          type: string
          example: rule1
          exampleSetFlag: true
        rule:
          $ref: '#/components/schemas/RuleCommon'
          exampleSetFlag: true
      description: Outbound Rule
      exampleSetFlag: false
    Provided:
      title: Provided
      type: object
      properties:
        contracts:
          type: array
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
      exampleSetFlag: false
    Consumed:
      title: Consumed
      type: object
      properties:
        contractIfs:
          type: array
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        contracts:
          type: array
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
      exampleSetFlag: false
    EgressFilterBatch:
      title: EgressFilterBatch
      type: object
      properties:
        creates:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/EgressFilter'
            exampleSetFlag: false
        deletes:
          type: array
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        updates:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/EgressFilter'
            exampleSetFlag: false
      description: Outbound Rule batch configuration
      exampleSetFlag: false