Dispel API

openapi: 3.1.0
info:
  title: Dispel API
  version: '2026-10-23'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-23: 19 operation(s) read from 19 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Dispel has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 19
    pages-with-code: 0
    pages-read: 19
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-23'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.dispel.com/reference/wicket-tunnel-encryption.md
  - https://docs.dispel.com/regulatory-framework-mappings/dhs-tic/vol.-2-reference-architecture.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/connect-with-an-rdp-client.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-macos.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-windows.md
  - https://docs.dispel.com/get-started/getting-started-with-dispel.md
  - https://docs.dispel.com/secure-and-govern/dispel-identity/getting-started.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application.md
  - https://docs.dispel.com/get-started/getting-started-with-dispel/user-quick-start-guide.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/stacks.md
  - https://docs.dispel.com/get-started/getting-started-with-dispel/org-admin-quick-start-guide.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/vdi-users.md
  - https://docs.dispel.com/get-started/getting-started-with-dispel/facility-admin-quick-start-guide.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect/join-a-shared-session.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect/use-a-browser-connect-session.md
  - https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/reserve-a-virtual-desktop-user.md
paths:
  /connect-to-your-systems/connection-methods.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_md
      tags:
      - Connect To Your Systems
      summary: Connection Methods
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/browser-connect.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_browser_connect_md
      tags:
      - Connect To Your Systems
      summary: Browser Connect
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/browser-connect/join-a-shared-session.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_browser_connect_join_a_shared_ses
      tags:
      - Connect To Your Systems
      summary: Join a shared Browser Connect session
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect/join-a-shared-session.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/browser-connect/use-a-browser-connect-session.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_browser_connect_use_a_browser_con
      tags:
      - Connect To Your Systems
      summary: Use a Browser Connect session
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/browser-connect/use-a-browser-connect-session.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/dispel-application.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_dispel_application_md
      tags:
      - Connect To Your Systems
      summary: Dispel Application
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  ? /connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-macos.md
  : get:
      operationId: get_connect_to_your_systems_connection_methods_dispel_application_import_install
      tags:
      - Connect To Your Systems
      summary: Install the Dispel VPN Client (macOS)
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-macos.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  ? /connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-windows.md
  : get:
      operationId: get_connect_to_your_systems_connection_methods_dispel_application_import_install
      tags:
      - Connect To Your Systems
      summary: Install the Dispel VPN Client (Windows)
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/dispel-application/import-install-and-connect-with-the-dispel-vpn-client-windows.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader user goal describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/virtual-desktops.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_virtual_desktops_md
      tags:
      - Connect To Your Systems
      summary: Virtual Desktops
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/virtual-desktops/connect-with-an-rdp-client.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_virtual_desktops_connect_with_an_
      tags:
      - Connect To Your Systems
      summary: Connect with an RDP client
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/connect-with-an-rdp-client.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/virtual-desktops/reserve-a-virtual-desktop-user.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_virtual_desktops_reserve_a_virtua
      tags:
      - Connect To Your Systems
      summary: Reserve a Virtual Desktop (User)
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/reserve-a-virtual-desktop-user.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/virtual-desktops/stacks.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_virtual_desktops_stacks_md
      tags:
      - Connect To Your Systems
      summary: Stacks
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/stacks.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connect-to-your-systems/connection-methods/virtual-desktops/vdi-users.md:
    get:
      operationId: get_connect_to_your_systems_connection_methods_virtual_desktops_vdi_users_md
      tags:
      - Connect To Your Systems
      summary: VDI Users
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/connect-to-your-systems/connection-methods/virtual-desktops/vdi-users.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /get-started/getting-started-with-dispel.md:
    get:
      operationId: get_get_started_getting_started_with_dispel_md
      tags:
      - Get Started
      summary: Getting Started with Dispel
      description: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters. The response will contain a direct
        answer to the question and relevant excerpts and sources from the documentation.
      x-source: https://docs.dispel.com/get-started/getting-started-with-dispel.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /get-started/getting-started-with-dispel/facility-admin-quick-start-guide.md:
    get:
      operationId: get_get_started_getting_started_with_dispel_facility_admin_quick_start_guide_md
      tags:
      - Get Started
      summary: Facility Admin Quick Start Guide
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve answers from the documentation.
      x-source: https://docs.dispel.com/get-started/getting-started-with-dispel/facility-admin-quick-start-guide.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user's ultimate goal for the request.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /get-started/getting-started-with-dispel/org-admin-quick-start-guide.md:
    get:
      operationId: get_get_started_getting_started_with_dispel_org_admin_quick_start_guide_md
      tags:
      - Get Started
      summary: Org Admin Quick Start Guide
      x-source: https://docs.dispel.com/get-started/getting-started-with-dispel/org-admin-quick-start-guide.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /get-started/getting-started-with-dispel/user-quick-start-guide.md:
    get:
      operationId: get_get_started_getting_started_with_dispel_user_quick_start_guide_md
      tags:
      - Get Started
      summary: User Quick Start Guide
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/get-started/getting-started-with-dispel/user-quick-start-guide.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /reference/wicket-tunnel-encryption.md:
    get:
      operationId: get_reference_wicket_tunnel_encryption_md
      tags:
      - Reference
      summary: Wicket Tunnel Encryption
      x-source: https://docs.dispel.com/reference/wicket-tunnel-encryption.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'The immediate question: it should be specific, self-contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /regulatory-framework-mappings/dhs-tic/vol.-2-reference-architecture.md:
    get:
      operationId: get_regulatory_framework_mappings_dhs_tic_vol_2_reference_architecture_md
      tags:
      - Regulatory Framework Mappings
      summary: 'Vol. 2: Reference Architecture'
      description: Performs an HTTP GET request on the documentation page with optional `ask` and `goal` query parameters to retrieve a direct
        answer and relevant excerpts.
      x-source: https://docs.dispel.com/regulatory-framework-mappings/dhs-tic/vol.-2-reference-architecture.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; specific, self‑contained, natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /secure-and-govern/dispel-identity/getting-started.md:
    get:
      operationId: get_secure_and_govern_dispel_identity_getting_started_md
      tags:
      - Secure And Govern
      summary: Getting Started
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.dispel.com/secure-and-govern/dispel-identity/getting-started.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question; should be specific, self-contained, and written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want rather than restating the question.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
tags:
- name: Connect To Your Systems
- name: Get Started
- name: Reference
- name: Regulatory Framework Mappings
- name: Secure And Govern