Cisco Identity Services Engine Adresourcereservation API

openapi: 3.2.0
info:
  title: Cisco Ise Adresourcereservation API
  version: '1.0'
  description: 'Operations tagged adresourcereservation across 2 of this provider''s published API definitions: cisco-ise-ers-open-api-ers-apis.yaml,
    cisco-ise-legacy-ers-active-directory-resource-reservation.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-active-directory-resource-reservation.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-active-directory-resource-reservation.yaml
    operation_coverage: 5/9
  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: adresourcereservation
paths:
  /adresourcereservation/:
    get:
      tags:
      - adresourcereservation
      summary: Get-All
      parameters:
      - $ref: '#/components/parameters/ppage'
      - $ref: '#/components/parameters/psize'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/adresourcereservationListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/adresourcereservationListResponse'
            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'
  /adresourcereservation/name/{name}:
    get:
      tags:
      - adresourcereservation
      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/adresourcereservationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/adresourcereservationResponse'
            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'
  /adresourcereservation/{id}:
    get:
      tags:
      - adresourcereservation
      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/adresourcereservationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/adresourcereservationResponse'
            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: []
    put:
      tags:
      - adresourcereservation
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identitystores.adresourcereservation'
            example:
              ERSADResourceReservation:
                node: node1.com
                joinPointNames: jp1,jp2,jp3
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
        '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 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
      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/adresourcereservation/{id}:
    get:
      tags:
      - adresourcereservation
      summary: Fetch AD resource reservation details by ID.
      description: <p>This API fetches the AD resource reservation details by ID. The ID can be retrieved with the Get All
        operation.p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header (not mandatory)
        description: Example:- identitystores.adresourcereservation.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP 'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI)
        description: The Token value from the GET X-CSRF-TOKEN fetch request Example:- fetch
        required: false
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSADResourceReservation_2'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSADResourceReservation_2'
  /ers/config/adresourcereservation/{id}/:
    put:
      tags:
      - adresourcereservation
      summary: Update AD resource reservation by ID.
      description: <p>This API fetches the AD resource reservation details by ID. The ID can be retrieved with the Get All
        operation.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header (Not Mandatory)
        description: Example:- dentitystores.adresourcereservation.1.0
        required: false
        schema:
          type: string
      responses:
        204:
          description: OK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ERSADResourceReservation_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/ERSADResourceReservation_2'
  /ers/config/adresourcereservation/:
    get:
      tags:
      - adresourcereservation
      summary: List all Active Directory Resource Reservation in Cisco ISE.
      description: <p>This API lists all Active Directory Resource Reservation in Cisco ISE.</p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header (not mandatory)
        description: Example:- identitystores.activedirectory.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header (Required Only if Enabled from GUI)
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/definitions'
            application/xml:
              schema:
                $ref: '#/definitions'
  /ers/config/adresourcereservation/name/{name}:
    get:
      tags:
      - adresourcereservation
      summary: Get Active Directory resource reservation by name
      description: <p>This API allows the client to get Active Directory resource reservation by node name. This API also
        allows the client to fetch join point details by Name. The node Name can be retrieved with the Get All operation.</p>
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header(not mandatory)
        description: Example:- identitystores.adresourcereservation.1.0
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header (Required Only if Enabled from GUI)
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSADResourceReservation_2'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSADResourceReservation_2'
  /ers/config/adresourcereservation/versioninfo:
    get:
      tags:
      - adresourcereservation
      summary: Get Active Directory Resource Reservation information
      description: <p>This API helps to retrieve the revision version information related to the active directory Resource
        Reservation  API.</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
    adresourcereservationResponseEntity:
      properties:
        node:
          title: node
          type: string
          description: PSN name
          example: null
        joinPointNames:
          title: joinPointNames
          type: string
          description: Selected Join Points in PSN
          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
    adresourcereservationListResponseEntity:
      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
    updatedField:
      properties:
        field:
          type: string
          example: null
        oldValue:
          type: string
          example: null
        newValue:
          type: string
          example: null
      example: null
    ERSADResourceReservation:
      required:
      - name
      - node
      properties:
        node:
          title: node
          type: string
          description: PSN name
          example: null
        joinPointNames:
          title: joinPointNames
          type: string
          description: Selected Join Points in PSN
          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:
        ERSADResourceReservation:
          node: node1.com
          joinPointNames: jp1,jp2,jp3
    identitystores.adresourcereservation:
      required:
      - ERSADResourceReservation
      type: object
      properties:
        ERSADResourceReservation:
          $ref: '#/components/schemas/ERSADResourceReservation'
      example: null
    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
    UpdatedFieldsResponse:
      type: object
      properties:
        UpdatedFieldsList:
          type: object
          properties:
            updatedField:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/updatedField'
          example: null
      example: null
    adresourcereservationResponse:
      type: object
      properties:
        ERSADResourceReservation:
          $ref: '#/components/schemas/adresourcereservationResponseEntity'
      example:
        ERSADResourceReservation:
          node: node1.com
          joinPointNames: jp1,jp2,jp3
    adresourcereservationListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/adresourcereservationListResponseEntity'
          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
    ERSADResourceReservation_2:
      type: object
      properties:
        node:
          type: string
          example: node 1.com
        joinPointNames:
          type: string
          example: jp1,jp2,jp3
    VersionInfo:
      type: object
      properties:
        VersionInfo:
          $ref: '#/components/schemas/version'
    version:
      type: object
      properties:
        currentServerVersion:
          type: string
          example: 1.2
        supportedVersions:
          type: string
          example: 1.0,1.1,1.2
        link:
          $ref: '#/components/schemas/link1'
    link1:
      type: object
      properties:
        rel:
          type: string
          example: self
        href:
          type: string
          example: https://<ise-ip>:9060/ers/config/adresourcereservation/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-active-directory-resource-reservation.yaml