Cisco Identity Services Engine
Cisco Identity Services Engine Sxpvpns API

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

openapi: 3.2.0
info:
  title: Cisco Ise Sxpvpns API
  version: '1.0'
  description: 'Operations tagged sxpvpns across 2 of this provider''s published API definitions: cisco-ise-ers-open-api-ers-apis.yaml,
    cisco-ise-legacy-ers-sxp-vpns.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-sxp-vpns.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-sxp-vpns.yaml
    operation_coverage: 7/11
  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: sxpvpns
paths:
  /sxpvpns/:
    get:
      tags:
      - sxpvpns
      summary: Get-All
      parameters:
      - name: filter
        in: query
        description: Filter Supported Fields:[name, description]
        required: false
        allowReserved: true
        schema:
          type: string
          example: toDate.CONTAINS.SEP
      - $ref: '#/components/parameters/ppage'
      - $ref: '#/components/parameters/psize'
      - name: sortdsc
        in: query
        description: Sorting Supported Fields:[name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - name
          - description
      - name: sortasc
        in: query
        description: Sorting Supported Fields:[name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - name
          - description
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sxpvpnsListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/sxpvpnsListResponse'
            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: []
    post:
      tags:
      - sxpvpns
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sxp.sxpvpns'
            example:
              ERSSxpVpn:
                sxpVpnName: SxpVpn1
        required: true
      responses:
        '201':
          description: Created
        '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
      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'
  /sxpvpns/{id}:
    get:
      tags:
      - sxpvpns
      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/sxpvpnsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/sxpvpnsResponse'
            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: []
    delete:
      tags:
      - sxpvpns
      summary: Delete
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '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/sxpvpns/{id}:
    get:
      tags:
      - sxpvpns
      summary: Get SXP VPN by ID
      description: <p>This API allows the client to get a SXP VPN by ID.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- sxp.sxpvpns.1.0
        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/sxpvpns'
            application/xml:
              schema:
                $ref: '#/components/schemas/sxpvpns'
    delete:
      tags:
      - sxpvpns
      summary: Delete SXP VPN
      description: <p>This API deletes a SXP VPN.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- sxp.sxpvpns.1.0
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      responses:
        204:
          description: No Content
  /ers/config/sxpvpns:
    get:
      tags:
      - sxpvpns
      summary: Get all SXP VPNs
      description: <p>This API allows the client to get all the SXP VPNs.</p> <p><h1>Filter:</h1> <h3>[name, description]</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> <p><h1>Sorting:</h1> <h3>[name,
        description]</h3></p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- sxp.sxpvpns.1.0
        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'
    post:
      tags:
      - sxpvpns
      summary: Create SXP VPN
      description: <p>This API creates a SXP VPN.</p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- sxp.sxpvpns.1.0
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      - in: header
        name: Bulk Support
        description: Operation 'Create' can be used within Bulk Request
        schema:
          type: string
      responses:
        201:
          description: Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sxpvpns'
          application/xml:
            schema:
              $ref: '#/components/schemas/sxpvpns'
  /ers/config/sxpvpns/versioninfo:
    get:
      tags:
      - sxpvpns
      summary: Get SXP VPNs version information
      description: <p>This API helps to retrieve the version information related to the SXP VPNs.</p>
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionInfo'
  /ers/config/sxpvpns/submit:
    put:
      tags:
      - sxpvpns
      summary: Submit bulk request
      description: <p>This API allows the client to submit the bulk request.</p>
      responses:
        202:
          description: Accepted
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkrequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/bulkrequest'
  /ers/config/sxpvpns/bulk/{bulkid}:
    get:
      tags:
      - sxpvpns
      summary: Monitor bulk request
      description: <p>This API allows the client to monitor the bulk request.</p>
      parameters:
      - name: bulkid
        in: path
        required: true
        description: 'The bulk ID is a dynamically generated value.<br>For example :- ‘615360357673’

          '
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkstatus'
            application/xml:
              schema:
                $ref: '#/components/schemas/bulkstatus'
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
    sxp.sxpvpns:
      required:
      - ERSSxpVpn
      type: object
      properties:
        ERSSxpVpn:
          $ref: '#/components/schemas/ERSSxpVpn'
      example: null
    sxpvpnsListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/sxpvpnsListResponseEntity'
          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
    ERSSxpVpn:
      required:
      - sxpVpnName
      properties:
        sxpVpnName:
          title: sxpVpnName
          type: string
          description: ''
          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:
        ERSSxpVpn:
          sxpVpnName: SxpVpn1
    sxpvpnsListResponseEntity:
      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
    sxpvpnsResponseEntity:
      properties:
        sxpVpnName:
          title: sxpVpnName
          type: string
          description: ''
          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
    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
    sxpvpnsResponse:
      type: object
      properties:
        ERSSxpVpn:
          $ref: '#/components/schemas/sxpvpnsResponseEntity'
      example:
        ERSSxpVpn:
          sxpVpnName: SxpVpn1
    bulkrequest:
      type: object
      properties:
        VpnBulkRequest:
          $ref: '#/components/schemas/VpnBulkRequest'
    VpnBulkRequest:
      type: object
      properties:
        operationType:
          type: string
          example: create
        resourceMediaType:
          type: string
          example: vnd.com.cisco.ise.sxp.sxpvpns.1.0+xml
    VersionInfo:
      type: object
      properties:
        VersionInfo:
          $ref: '#/components/schemas/version'
    SearchResult:
      type: object
      properties:
        total:
          type: integer
          example: 1
        resources:
          type: array
          example:
          - id: ef36ca16-0cf7-4806-b2a9-6f547cfe4805
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/sxpvpns/ef36ca16-0cf7-4806-b2a9-6f547cfe4805
              type: application/json
          items:
            properties:
              name:
                type: string
    ERSSxpVpn_2:
      type: object
      properties:
        id:
          type: string
          example: ef36ca16-0cf7-4806-b2a9-6f547cfe4805
        sxpVpnName:
          type: string
          example: default
        link:
          type: object
          properties:
            rel:
              type: string
              example: self
            href:
              type: string
              example: https://<ise-ip>:9060/ers/config/ers/config/sxpvpns/ef36ca16-0cf7-4806-b2a9-6f547cfe4805
            type:
              type: string
              example: application/json
    bulkstatus:
      type: object
      properties:
        BulkStatus:
          $ref: '#/components/schemas/BulkStatus'
    search:
      type: object
      properties:
        SearchResult:
          $ref: '#/components/schemas/SearchResult'
    BulkStatus:
      type: object
      properties:
        bulkId:
          type: string
          example: 1615791703003
        mediaType:
          type: string
          example: ''
        executionStatus:
          type: string
          example: COMPLETED
        operationType:
          type: string
          example: create
        startTime:
          type: string
          example: Mon Mar 15 07:01:43 UTC 2021
        resourcesCount:
          type: integer
          example: 5
        successCount:
          type: integer
          example: 5
        failCount:
          type: integer
          example: 0
        resourcesStatus:
          type: array
          example:
          - id: '1234454324'
            name: resource1
            description: description...
            resourceExecutionStatus: PENDING
            status: PENDING
          - id: '2343242342'
            name: resource2
            description: description...
            resourceExecutionStatus: PENDING
            status: PENDING
          - id: '4564566456'
            name: resource3
            description: description...
            resourceExecutionStatus: PENDING
            status: PENDING
          - id: '6544566455'
            name: resource4
            description: description...
            resourceExecutionStatus: PENDING
            status: PENDING
          items:
            properties:
              name:
                type: string
    version:
      type: object
      properties:
        currentServerVersion:
          type: string
          example: '1.0'
        supportedVersions:
          type: string
          example: '1.0'
        link:
          $ref: '#/components/schemas/link1'
    sxpvpns:
      type: object
      properties:
        ERSSxpVpn:
          $ref: '#/components/schemas/ERSSxpVpn_2'
    link1:
      type: object
      properties:
        rel:
          type: string
          example: self
        href:
          type: string
          example: https://<ise-ip>:9060/ers/config/sxpvpns/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-sxp-vpns.yaml
Cisco Identity Services Engine Sxpvpns API

Documentation

Specifications

Other Resources

OpenAPI Specification
