Cisco Identity Services Engine
Cisco Identity Services Engine Node API

The node API from Cisco Identity Services Engine — 7 operation(s) for node.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.2.0
info:
  title: Cisco Ise Node API
  version: '1.0'
  description: 'Operations tagged node across 2 of this provider''s published API definitions: cisco-ise-ers-open-api-ers-apis.yaml,
    cisco-ise-legacy-ers-node-details.yaml. Each path carries the servers of the definition it was published in.'
  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.
    derived_view: Per-tag view of cisco-ise-legacy-ers-node-details.yaml, the provider's source document. Operations and schemas
      are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-ise-legacy-ers-node-details.yaml
    operation_coverage: 4/7
  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'
tags:
- name: node
paths:
  /node/:
    get:
      tags:
      - node
      summary: Get-All
      parameters:
      - name: filter
        in: query
        description: Filter Supported Fields:[nodeservicetypes]
        required: false
        allowReserved: true
        schema:
          type: string
          example: toDate.CONTAINS.SEP
      - $ref: '#/components/parameters/ppage'
      - $ref: '#/components/parameters/psize'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/nodeListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/nodeListResponse'
            text/html:
              schema:
                type: string
                example: null
        '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
      security:
      - HTTPBasicAuthentication: []
    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'
  /node/name/{name}:
    get:
      tags:
      - node
      summary: Get-By-Name
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/nodeResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/nodeResponse'
            text/html:
              schema:
                type: string
                example: null
        '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
      security:
      - HTTPBasicAuthentication: []
    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'
  /node/{id}:
    get:
      tags:
      - node
      summary: Get-By-Id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/nodeResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/nodeResponse'
            text/html:
              schema:
                type: string
                example: null
        '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
      security:
      - HTTPBasicAuthentication: []
    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'
  /ers/config/node/name/{name}:
    get:
      tags:
      - node
      summary: Get node details by name
      description: <p>This API allows the client to get node details by name.</p>
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- deploy.node.1.2
        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:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/nodedetails_name'
            application/xml:
              schema:
                $ref: '#/components/schemas/nodedetails_name'
  /ers/config/node/{id}:
    get:
      tags:
      - node
      summary: Get node details by ID
      description: <p>This API allows the client to get node details by ID.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- deploy.node.1.2
        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:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/node'
            application/xml:
              schema:
                $ref: '#/components/schemas/node'
  /ers/config/node:
    get:
      tags:
      - node
      summary: Get all node details
      description: <p>This API allows the client to get all the node details.</p> <p><h1>Filter:</h1> <h3>[nodeservicetypes]</h3></p>
        <p>To search guest users by using <b>toDate</b> column,follow the format:</p> <p>DD-MON-YY (Example:13-SEP-18)</p>
        <ul> <li><p>Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13</p></li> <li><p>Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP</p></li>
        <li><p>Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18</p></li> </ul>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:-   deploy.node.1.2
        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:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search'
            application/xml:
              schema:
                $ref: '#/components/schemas/search'
  /ers/config/node/versioninfo:
    get:
      tags:
      - node
      summary: Get node details version information
      description: <p>This API helps to retrieve the version information realted to the node details.</p>
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionInfo'
components:
  schemas:
    Link:
      type: object
      properties:
        rel:
          type: string
          example: self
          enum:
          - next
          - previous
          - self
          - status
        href:
          type: string
          example: https://{server}:{port}/ers/config
        type:
          type: string
          example: application/json
      example: null
    nodeResponseEntity:
      properties:
        gateWay:
          title: gateWay
          type: string
          description: Node's gateway IP address
          example: null
        displayName:
          title: displayName
          type: string
          description: Node display name
          example: null
        inDeployment:
          title: inDeployment
          type: string
          description: Is node part of deployment
          example: null
        ipAddresses:
          title: ipAddresses
          type: object
          description: IPv4 of all the interfaces
          example: null
        userName:
          title: userName
          type: string
          description: Node username
          example: null
        passWord:
          title: passWord
          type: string
          description: Node password
          example: null
        otherPapFqdn:
          title: otherPapFqdn
          type: string
          description: FQDN of another PAN node
          example: null
        ipAddress:
          title: ipAddress
          type: string
          description: Management IPv4 address
          example: null
        sxpIpAddress:
          title: sxpIpAddress
          type: string
          description: SXP IPv4 address
          example: null
        nodeServiceTypes:
          title: nodeServiceTypes
          type: string
          description: Node service types
          example: null
        fqdn:
          title: fqdn
          type: string
          description: Node FQDN
          example: null
        primaryPapNode:
          title: primaryPapNode
          type: boolean
          description: Is primary PAN
          example: null
        papNode:
          title: papNode
          type: boolean
          description: Is PAN node
          example: null
        pxGridNode:
          title: pxGridNode
          type: boolean
          description: Is pxGrid node
          example: null
        ipV6Address:
          title: ipV6Address
          type: string
          description: Management IPv6 address
          example: null
        secIpV6Address:
          title: secIpV6Address
          type: string
          description: Secondary management IPv6 address
          example: null
        ipV6Addresses:
          title: ipV6Addresses
          type: object
          description: IPv6 of all the interfaces
          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
        link:
          $ref: '#/components/schemas/Link'
      example: null
    nodeResponse:
      type: object
      properties:
        Node:
          $ref: '#/components/schemas/nodeResponseEntity'
      example:
        Node:
          passWord: TestPassword
          ipV6Addresses:
          - 2001:db8::1
          - fe80::1
          otherPapFqdn: OtherTestNode
          inDeployment: true
          fqdn: test.ers.cisco.com
          displayName: TestNode
          ipAddress: 10.0.0.3
          nodeServiceTypes: DEVICE ADMIN
          userName: Testuser
          papNode: true
          pxGridNode: true
          ipV6Address: 2001:db8::1
          secIpV6Address: 2001:db8::2
          name: TestNode
          sxpIpAddress: 10.10.10.1
          ipAddresses:
          - 10.0.0.1
          - 10.0.0.2
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
          gateWay: 10.0.10.11
          primaryPapNode: true
    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
    nodeListResponseEntity:
      properties:
        id:
          title: id
          type: string
          description: Id description
          example: null
        name:
          title: name
          type: string
          description: name description
          example: null
        description:
          title: description
          type: string
          description: description
          example: null
        link:
          $ref: '#/components/schemas/Link'
      example: null
    nodeListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/nodeListResponseEntity'
          example: null
      example:
        SearchResult:
          total: 2
          previousPage:
            rel: previous
            href: link-to-previous-page
            type: application/xml
          nextPage:
            rel: next
            href: link-to-next-page
            type: application/xml
          resources:
          - name: name1
            link:
              rel: self
              href: <url to resource name1>
              type: application/xml
            description: description1
            id: id1
          - name: name2
            link:
              rel: self
              href: <url to resource name2>
              type: application/xml
            description: description2
            id: id2
    nodedetails_name:
      type: object
      properties:
        Node:
          $ref: '#/components/schemas/Node_name'
    Node:
      type: object
      properties:
        id:
          type: string
          example: ab6deded-fcc2-47ff-8577-0014737c8fcf
        name:
          type: string
          example: TestNode
        gateWay:
          type: string
          example: 10.0.10.11
        userName:
          type: string
          example: Testuser
        passWord:
          type: string
          example: TestPassword
        displayName:
          type: string
          example: TestNode
        inDeployment:
          type: boolean
          example: true
        otherPapFqdn:
          type: string
          example: OtherTestNode
        ipAddresses:
          type: array
          example:
          - 10.0.0.1
          - 10.0.0.2
          items:
            properties:
              name:
                type: string
        ipAddress:
          type: string
          example: 10.0.0.3
        sxpIpAddress:
          type: string
          example: 10.10.10.1
        nodeServiceTypes:
          type: string
          example: DEVICE ADMIN
        fqdn:
          type: string
          example: test.ers.cisco.com
        papNode:
          type: boolean
          example: true
        primaryPapNode:
          type: boolean
          example: true
        pxGridNode:
          type: boolean
          example: true
        link:
          type: object
          properties:
            rel:
              type: string
              example: self
            href:
              type: string
              example: https://<ise-ip>:9060/ers/config/ers/config/node/ab6deded-fcc2-47ff-8577-0014737c8fcf
            type:
              type: string
              example: application/json
    node:
      type: object
      properties:
        Node:
          $ref: '#/components/schemas/Node'
    VersionInfo:
      type: object
      properties:
        VersionInfo:
          $ref: '#/components/schemas/version'
    SearchResult:
      type: object
      properties:
        total:
          type: integer
          example: 1
        resources:
          type: array
          example:
          - id: '  ab6deded-fcc2-47ff-8577-0014737c8fcf'
            name: TestNode
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/node/ab6deded-fcc2-47ff-8577-0014737c8fcf
              type: application/json
          items:
            properties:
              name:
                type: string
    Node_name:
      type: object
      properties:
        id:
          type: string
          example: ab6deded-fcc2-47ff-8577-0014737c8fcf
        name:
          type: string
          example: TestNode
        gateWay:
          type: string
          example: 10.0.10.11
        userName:
          type: string
          example: Testuser
        passWord:
          type: string
          example: TestPassword
        displayName:
          type: string
          example: TestNode
        inDeployment:
          type: boolean
          example: true
        otherPapFqdn:
          type: string
          example: OtherTestNode
        ipAddresses:
          type: array
          example:
          - 10.0.0.1
          - 10.0.0.2
          items:
            properties:
              name:
                type: string
        ipAddress:
          type: string
          example: 10.0.0.3
        sxpIpAddress:
          type: string
          example: 10.10.10.1
        nodeServiceTypes:
          type: string
          example: DEVICE ADMIN
        fqdn:
          type: string
          example: test.ers.cisco.com
        papNode:
          type: boolean
          example: true
        primaryPapNode:
          type: boolean
          example: true
        pxGridNode:
          type: boolean
          example: true
        link:
          type: object
          properties:
            rel:
              type: string
              example: self
            href:
              type: string
              example: https://<ise-ip>:9060/ers/config/ers/config/node/name/TestNode
            type:
              type: string
              example: application/json
    search:
      type: object
      properties:
        SearchResult:
          $ref: '#/components/schemas/SearchResult'
    version:
      type: object
      properties:
        currentServerVersion:
          type: string
          example: '1.2'
        supportedVersions:
          type: string
          example: 1.0,1.1,1.2,1.3
        link:
          $ref: '#/components/schemas/link1'
    link1:
      type: object
      properties:
        rel:
          type: string
          example: self
        href:
          type: string
          example: https://<ise-ip>:9060/ers/config/node/versioninfo
        type:
          type: string
          example: application/json
  parameters:
    ppage:
      name: page
      in: query
      description: Page Number (0...N)
      allowReserved: true
      schema:
        type: integer
        example: null
      example: '1'
    psize:
      name: size
      in: query
      description: Items by Page
      allowReserved: true
      schema:
        type: integer
        example: null
      example: '20'
  securitySchemes:
    HTTPBasicAuthentication:
      type: http
      scheme: basic
x-refined-from:
- cisco-ise-ers-open-api-ers-apis.yaml
- cisco-ise-legacy-ers-node-details.yaml
Cisco Identity Services Engine Node API

Documentation

Specifications

Other Resources

OpenAPI Specification
