Cisco Identity Services Engine pxGrid Direct Push APIs API

openapi: 3.2.0
info:
  title: Cisco ISE API - pxGrid Direct pxGrid Direct Push APIs 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.160.16:44330
  description: Inferred Url
tags:
- name: pxGrid Direct Push APIs
paths:
  /api/v1/pxgrid-direct/push/{connectorName}:
    get:
      tags:
      - pxGrid Direct Push APIs
      summary: Get endpoint attribute data using the connector name
      description: pxGrid Direct API - Get endpoint attribute data using connector name, optional parameters for pagination
      operationId: getAllPushConnectorName
      parameters:
      - name: connectorName
        in: path
        description: Name of the connector.
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      - name: size
        in: query
        description: Number of objects returned per page
        required: false
        style: form
        schema:
          type: integer
          format: int32
          exampleSetFlag: true
      - name: page
        in: query
        description: Page number
        required: false
        style: form
        schema:
          type: integer
          format: int32
          exampleSetFlag: true
      responses:
        '200':
          description: Retrieve all the Endpoint attribute data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushConnectorConfigGetAllResponse'
                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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
  /api/v1/pxgrid-direct/push/{connectorName}/bulk:
    post:
      tags:
      - pxGrid Direct Push APIs
      summary: Bulk operator based on create/update/delete for the provided connector name
      description: pxGrid Direct Push - Bulk operator based on create/update/delete for the provided connector name, endpoint attribute in json is an array
      operationId: bulkOperationPushConnectors
      parameters:
      - name: connectorName
        in: path
        description: Name of the connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushConnectorConfigPostBodyBulk'
              exampleSetFlag: false
      responses:
        '200':
          description: Bulk operator based on create/update/delete for the provided connector name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPushConnectorResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - BasicAuth: []
  /api/v1/pxgrid-direct/push/{connectorName}/{uniqueId}:
    get:
      tags:
      - pxGrid Direct Push APIs
      summary: Get endpoint attribute data Based on UniqueID
      description: pxGrid Direct Push - Get endpoint attribute data Based on UniqueID
      operationId: getPushConnectorByUniqueId
      parameters:
      - name: connectorName
        in: path
        description: Name of the connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: uniqueId
        in: path
        description: Unique ID of the endpoint related to the Connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: endpoint attribute information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushConnectorConfigGetAllResponse'
                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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    put:
      tags:
      - pxGrid Direct Push APIs
      summary: Update endpoint attribute data based on UniqueId for the given connector name.
      description: pxGrid Direct Push - Update endpoint attribute data based on UniqueId for the given connector name.
      operationId: updatePushConnectorByUniqueId
      parameters:
      - name: connectorName
        in: path
        description: Name of the connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: uniqueId
        in: path
        description: Unique ID of the endpoint related to the Connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushConnectorConfigInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Update endpoint attribute data based on UniqueId for the given connector name.
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '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
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    delete:
      tags:
      - pxGrid Direct Push APIs
      summary: Delete endpoint attribute data based on UniqueId for the given connector name.
      description: pxGrid Direct Push - Delete endpoint attribute data based on UniqueId for the given connector name.
      operationId: deletePushConnectorByUniqueId
      parameters:
      - name: connectorName
        in: path
        description: Name of the connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: uniqueId
        in: path
        description: Unique ID of the endpoint related to the Connector
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Delete endpoint attribute data based on UniqueId for the given connector name.
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '204':
          description: No Content
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
components:
  schemas:
    PushConnectorConfigGetAllResponse:
      title: PushConnectorConfigGetAllResponse
      type: object
      properties:
        data:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/PushConnectorConfigInfo'
            exampleSetFlag: false
      description: ConnectorConfig information format
      exampleSetFlag: false
    Error:
      title: Error
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          example: '400'
          exampleSetFlag: true
        message:
          type: string
          example: Bad Request
          exampleSetFlag: true
      exampleSetFlag: false
    PushConnectorConfigPostBodyBulk:
      title: PushConnectorConfigPostBodyBulk
      type: object
      properties:
        data:
          type: array
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/PushConnectorConfigInfo'
            exampleSetFlag: false
        operation:
          type: string
          example: create
          exampleSetFlag: true
      exampleSetFlag: false
    BulkPushConnectorResponse:
      title: BulkPushConnectorResponse
      type: object
      properties:
        connectorName:
          type: string
          description: connectorName
          example: PUSH_CONNECTOR
          exampleSetFlag: true
        data:
          type: string
          description: Response data
          example: JSON-object
          exampleSetFlag: true
        status:
          type: string
          description: status of the request
          example: Endpoint bulk request received, processing
          exampleSetFlag: true
      description: Response to Bulk Request
      exampleSetFlag: false
    PushConnectorConfigInfo:
      title: PushConnectorConfigInfo
      type: object
      properties:
        anyJsonArray:
          type: array
          description: any array
          example: '["Group1","Group2"]'
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        anyJsonBoolean:
          type: boolean
          description: any boolean value
          example: true
          exampleSetFlag: true
        anyJsonInteger:
          type: integer
          description: any integer
          format: int32
          example: 111
          exampleSetFlag: true
        anyJsonNumber:
          type: number
          description: any number
          format: bigdecimal
          example: 999
          exampleSetFlag: true
        anyJsonObject:
          type: object
          example: '{"value":{"id":"ObjectName","name":"ObjectValue"}}'
          exampleSetFlag: true
        anyJsonString:
          type: string
          description: any string
          example: anyJsonString
          exampleSetFlag: true
      exampleSetFlag: false