openapi: 3.0.3
info:
  title: ZAP accessControl websocket API
  description: The HTTP API for controlling and accessing ZAP.
  contact:
    name: ZAP User Group
    url: https://groups.google.com/group/zaproxy-users
    email: zaproxy-users@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.16.1
servers:
- url: http://zap
  description: The URL while proxying through ZAP.
- url: http://{address}:{port}
  description: The URL of a Local Proxy of ZAP.
  variables:
    address:
      description: The address ZAP is listening on.
      default: 127.0.0.1
    port:
      description: The port ZAP is bound to.
      default: '8080'
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: websocket
paths:
  /JSON/websocket/action/sendTextMessage/:
    parameters:
    - name: channelId
      in: query
      required: true
      description: ''
      schema:
        type: string
    - name: outgoing
      in: query
      required: true
      description: ''
      schema:
        type: string
    - name: message
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client
      operationId: websocketActionSendTextMessage
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/websocket/action/setBreakTextMessage/:
    parameters:
    - name: message
      in: query
      required: true
      description: ''
      schema:
        type: string
    - name: outgoing
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Sets the text message for an intercepted websockets message
      operationId: websocketActionSetBreakTextMessage
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/websocket/view/breakTextMessage/:
    get:
      description: Returns a text representation of an intercepted websockets message
      operationId: websocketViewBreakTextMessage
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/websocket/view/channels/:
    get:
      description: Returns all of the registered web socket channels
      operationId: websocketViewChannels
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/websocket/view/message/:
    parameters:
    - name: channelId
      in: query
      required: true
      description: ''
      schema:
        type: string
    - name: messageId
      in: query
      required: true
      description: ''
      schema:
        type: string
    get:
      description: Returns full details of the message specified by the channelId and messageId
      operationId: websocketViewMessage
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
  /JSON/websocket/view/messages/:
    parameters:
    - name: channelId
      in: query
      description: ''
      schema:
        type: string
    - name: start
      in: query
      description: ''
      schema:
        type: string
    - name: count
      in: query
      description: ''
      schema:
        type: string
    - name: payloadPreviewLength
      in: query
      description: ''
      schema:
        type: string
    get:
      description: Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents
      operationId: websocketViewMessages
      tags:
      - websocket
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
components:
  responses:
    ErrorJson:
      description: Error of JSON endpoints.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorJson'
  schemas:
    ErrorJson:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
        message:
          type: string
        detail:
          type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: X-ZAP-API-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: apikey
      in: query