---
swagger: "2.0"
x-collection-name: Apica
x-complete: 0
info:
  title: Scenarios API Scenarios Proxy Sniffer Dictionaries
  version: 1.0.0
  description: Updates Proxy Sniffer scenario custom dictionary.
host: api.pingdom.com
schemes:
- http
produces:
- application/json
consumes:
- application/json
paths:
  ? '/alerts?check_id={check_id}&severity={severity}&enabled={enabled}&target_type={target_type}&target_id={target_id} '
  : ' get ':
      summary: Alerts
      description: Gets alerts filtered by set of optional parameters.
      operationId: -alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarg
      x-api-path-slug: alertscheck-idcheck-idampseverityseverityampenabledenabledamptarget-typetarget-typeamptarget-idtarget-id-get
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/{alert_id} ':
    ' get ':
      summary: Alerts
      description: Gets alert by Id.
      operationId: -alerts-alert-id-
      x-api-path-slug: alertsalert-id-get
      responses:
        200:
          description: OK
      tags:
      - Alerts
    ' put ':
      summary: Alerts
      description: Updates alert.
      operationId: -alerts-alert-id-
      x-api-path-slug: alertsalert-id-put
      responses:
        200:
          description: OK
      tags:
      - Alerts
    ' delete ':
      summary: Alerts
      description: Deletes alert by Id.
      operationId: -alerts-alert-id-
      x-api-path-slug: alertsalert-id-delete
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/{alert_type} ':
    ' post ':
      summary: Alerts
      description: Creates a new alert.
      operationId: -alerts-alert-type-
      x-api-path-slug: alertsalert-type-post
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/recipients ':
    ' get ':
      summary: Alerts Recipients
      description: Gets a list of all alert recipient's targets that are visible to
        you as a customer.
      operationId: -alerts-recipients-
      x-api-path-slug: alertsrecipients-get
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/recipients/{recipient_id} ':
    ' get ':
      summary: Alerts Recipients
      description: Gets a information about alert recipient's targets.
      operationId: -alerts-recipients-recipient-id-
      x-api-path-slug: alertsrecipientsrecipient-id-get
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/recipient/{recipient_id} ':
    ' put ':
      summary: Alerts Recipient
      description: Updates recipient along with sms and email targets associated.
      operationId: -alerts-recipient-recipient-id-
      x-api-path-slug: alertsrecipientrecipient-id-put
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/recipient ':
    ' post ':
      summary: Alerts Recipient
      description: Creates a new recipient with one sms and one email target associated.
      operationId: -alerts-recipient-
      x-api-path-slug: alertsrecipient-post
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/alerts/targets ':
    ' get ':
      summary: Alerts Targets
      description: Gets a list of all alert targets that are visible to you as a customer.
      operationId: -alerts-targets-
      x-api-path-slug: alertstargets-get
      responses:
        200:
          description: OK
      tags:
      - Alerts
  /alerts/configs/alertId:
    delete:
      summary: Deleting an alert
      description: Deleting an alert
      operationId: deleting-an-alert
      x-api-path-slug: alertsconfigsalertid-delete
      parameters:
      - in: path
        name: alertId
        description: The ID of the alert to be deleted
        type: string
      - in: path
        name: token
        description: Your API token
        type: string
      - in: body
        name: token
        description: Your API token
        schema:
          $ref: '#/definitions/holder'
      - in: query
        name: token
        description: Your API token
        type: string
      responses:
        200:
          description: OK
      tags:
      - Alerts
  /alerts/configs/subjectId:
    get:
      summary: Listing alerts by subject
      description: Get a list of all configured alerts for a specific subject (device
        or service).
      operationId: listing-alerts-by-subject
      x-api-path-slug: alertsconfigssubjectid-get
      parameters:
      - in: path
        name: subjectId
        description: The ID of the subject e
        type: string
      - in: path
        name: subjectType
        description: The type of the subject - device or service
        type: string
      - in: query
        name: subjectType
        description: The type of the subject - device or service
        type: string
      - in: path
        name: token
        description: Your API token
        type: string
      - in: query
        name: token
        description: Your API token
        type: string
      responses:
        200:
          description: OK
      tags:
      - Alerts
  /alerts/triggered:
    get:
      summary: Triggered Alerts
      description: Get a list of all triggered alerts on your account, per subject
        (device or service) or per alert config.
      operationId: triggered-alerts
      x-api-path-slug: alertstriggered-get
      parameters:
      - in: query
        name: closed
        description: Whether to filter by closed or open alerts - unset = all alerts,
          false = open alerts, true = closed alerts
        type: string
      - in: query
        name: filter
        description: You can provide a JSON encoded hash filter for the search that
          will return items that match the filter
        type: string
      - in: query
        name: subjectType
        description: The type of the subject - device, service, deviceGroup or serviceGroup
          if you also specify the subjectId as part of the URL (see examples below)
        type: string
      - in: query
        name: token
        description: Your API token
        type: string
      responses:
        200:
          description: OK
      tags:
      - Alerts
  '/checks/browser ':
    ' post ':
      summary: Checks Browser
      description: Creates a new browser check.
      operationId: -checks-browser-
      x-api-path-slug: checksbrowser-post
      responses:
        200:
          description: OK
      tags:
      - Browser
  '/checks/browser/{checkId} ':
    ' put ':
      summary: Checks Browser
      description: Updates a browser check.
      operationId: -checks-browser-checkid-
      x-api-path-slug: checksbrowsercheckid-put
      responses:
        200:
          description: OK
      tags:
      - Browser
  '/checks/browser/locations ':
    ' get ':
      summary: Checks Browser Locations
      description: Gets a list of all locations that are available for browser checks.
      operationId: -checks-browser-locations-
      x-api-path-slug: checksbrowserlocations-get
      responses:
        200:
          description: OK
      tags:
      - Browser
  /checks/browser/{checkId}/results/{resultId}/urldata:
    ' get ':
      summary: Checks Browser Results
      description: Gets a file that contains browser check result data.
      operationId: -checks-browser-checkid-results-resultid-urldataformatformat-
      x-api-path-slug: checksbrowsercheckidresultsresultidurldata-get
      responses:
        200:
          description: OK
      tags:
      - Browser
  '/checks/browser/{checkId}/results/urldata ':
    ' post ':
      summary: Checks Browser Results
      description: Gets browser check results in json format by result ids.
      operationId: -checks-browser-checkid-results-urldata-
      x-api-path-slug: checksbrowsercheckidresultsurldata-post
      responses:
        200:
          description: OK
      tags:
      - Browser
  '/checks ':
    ' get ':
      summary: Get Checks
      description: Gets a list of all checks that are visible to you as a user or
        a customer depending on the request context.
      operationId: getChecks
      x-api-path-slug: checks-get
      responses:
        200:
          description: OK
      tags:
      - Checks
  '/checks/{checkId} ':
    ' get ':
      summary: Get Check
      description: Gets info about a check, current SLA, last result and its status.
      operationId: getChecksCheck
      x-api-path-slug: checkscheckid-get
      responses:
        200:
          description: OK
      tags:
      - Checks
    ' put ':
      summary: Update Check
      description: Updates a check.
      operationId: putChecksCheck
      x-api-path-slug: checkscheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
    ' delete ':
      summary: Delete Check
      description: Deletes a check.
      operationId: deleteChecksCheck
      x-api-path-slug: checkscheckid-delete
      responses:
        200:
          description: OK
      tags:
      - Checks
  '/checks/{checkId}/lastvalue ':
    ' get ':
      summary: Get Checks Lastvalue
      description: Gets the absolute last value of a specific check.
      operationId: getChecksCheckLastvalue
      x-api-path-slug: checkscheckidlastvalue-get
      responses:
        200:
          description: OK
      tags:
      - Checks
  /checks/{checkId}/results/{millisecondsUtc}:
    ' get ':
      summary: Get Checks Results
      description: Gets a specific check result by a numeric java timestamp.
      operationId: getChecksCheckResultsMillisecondsutcDetailLevelDetailLevel
      x-api-path-slug: checkscheckidresultsmillisecondsutc-get
      responses:
        200:
          description: OK
      tags:
      - Checks
  /checks/{checkId}/results:
    ' get ':
      summary: Get Checks Results
      description: Gets the most recent check results.
      operationId: getChecksCheckResultsMostrecentMostrecent&detailLevelDetailLevel
      x-api-path-slug: checkscheckidresults-get
      responses:
        200:
          description: OK
      tags:
      - Checks
  ? |2-

        /api/{version}/checks
  : ? |2-

          get
    : summary: Get Check List
      description: Returns a list overview of all checks.
      operationId: |2-

        getApiVersionChecks
      x-api-path-slug: apiversionchecks-get
      parameters:
      - in: query
        name: include_tags
        description: Include tag list for each check
        type: <td>boolean</td>
      - in: query
        name: limit
        description: Limits the number of returned probes to the specified quantity
        type: <td>integer</td>
      - in: query
        name: offset
        description: Offset for listing
        type: <td>integer</td>
      - in: query
        name: tags
        description: Tag list separated by commas
        type: <td>string</td>
      responses:
        200:
          description: OK
      tags:
      - Checks
  '/checks/command ':
    ' post ':
      summary: Checks Command
      description: Creates a new Command check.
      operationId: -checks-command-
      x-api-path-slug: checkscommand-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command-v2 ':
    ' post ':
      summary: Checks Command
      description: Creates a new Command check (version 2).
      operationId: -checks-command-v2-
      x-api-path-slug: checkscommandv2-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command-v2/{checkId} ':
    ' put ':
      summary: Checks Command
      description: Updates a command check (version 2).
      operationId: -checks-command-v2-checkid-
      x-api-path-slug: checkscommandv2checkid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command/{checkId} ':
    ' put ':
      summary: Checks Command
      description: Updates a command check.
      operationId: -checks-command-checkid-
      x-api-path-slug: checkscommandcheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command/categories ':
    ' get ':
      summary: Checks Command Categories
      description: Gets a list of all command check categories that are available
        for you as customer.
      operationId: -checks-command-categories-
      x-api-path-slug: checkscommandcategories-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command-v2/categories ':
    ' get ':
      summary: Checks Command Categories
      description: Gets a list of all command check (version 2) categories that are
        available for you as customer.
      operationId: -checks-command-v2-categories-
      x-api-path-slug: checkscommandv2categories-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/command/locations ':
    ' get ':
      summary: Checks Command Locations
      description: Gets a list of all locations that are available for Command checks.
      operationId: -checks-command-locations-
      x-api-path-slug: checkscommandlocations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  /checks/command-v2/locations:
    ' get ':
      summary: Checks Command Locations
      description: Gets a list of all locations that are available for Command checks
        (version 2).
      operationId: -checks-command-v2-locationsprotocolprotocol-
      x-api-path-slug: checkscommandv2locations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Command
  '/checks/{checkId}/job ':
    ' get ':
      summary: Get Checks Job
      description: DEPRECATED. Gets the current job status for a check.
      operationId: -checks-checkid-job-
      x-api-path-slug: checkscheckidjob-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Jobs
    ' post ':
      summary: Get Checks Job
      description: Executes a check.
      operationId: -checks-checkid-job-
      x-api-path-slug: checkscheckidjob-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Jobs
  '/checks/ping ':
    ' post ':
      summary: Checks Ping
      description: Creates a new Ping check.
      operationId: -checks-ping-
      x-api-path-slug: checksping-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Pings
  '/checks/ping/{checkId} ':
    ' put ':
      summary: Checks Ping
      description: Updates a Ping check.
      operationId: -checks-ping-checkid-
      x-api-path-slug: checkspingcheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Pings
  '/checks/ping/locations ':
    ' get ':
      summary: Checks Ping Locations
      description: Gets a list of all locations that are available for Ping checks.
      operationId: -checks-ping-locations-
      x-api-path-slug: checkspinglocations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Pings
  '/checks/port ':
    ' post ':
      summary: Checks Port
      description: Creates a new Port check.
      operationId: -checks-port-
      x-api-path-slug: checksport-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Ports
  '/checks/port/{checkId} ':
    ' put ':
      summary: Checks Port
      description: Updates a Port check.
      operationId: -checks-port-checkid-
      x-api-path-slug: checksportcheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Ports
  '/checks/port/locations ':
    ' get ':
      summary: Checks Port Locations
      description: Gets a list of all locations that are available for Port checks.
      operationId: -checks-port-locations-
      x-api-path-slug: checksportlocations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Ports
  '/checks/proxysniffer ':
    ' post ':
      summary: Checks Proxy Sniffer
      description: Creates a new ProxySniffer check.
      operationId: -checks-proxysniffer-
      x-api-path-slug: checksproxysniffer-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/proxysniffer/{checkId} ':
    ' put ':
      summary: Checks Proxy Sniffer
      description: Updates a proxy sniffer check.
      operationId: -checks-proxysniffer-checkid-
      x-api-path-slug: checksproxysniffercheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/proxysniffer/locations ':
    ' get ':
      summary: Checks Proxy Sniffer Locations
      description: Gets a list of all locations that are available for ProxySniffer
        checks.
      operationId: -checks-proxysniffer-locations-
      x-api-path-slug: checksproxysnifferlocations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/proxysniffer/{checkId}/results/{resultId}/urldata?format={format} ':
    ' get ':
      summary: Checks Proxysniffer Results
      description: Gets a file that contains ProxySniffer check result data.
      operationId: -checks-proxysniffer-checkid-results-resultid-urldataformatformat-
      x-api-path-slug: checksproxysniffercheckidresultsresultidurldataformatformat-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/proxysniffer/{checkId}/results/urldata ':
    ' post ':
      summary: Checks Proxy Sniffer Results URLdata
      description: Gets ProxySniffer check results in json format by result ids.
      operationId: -checks-proxysniffer-checkid-results-urldata-
      x-api-path-slug: checksproxysniffercheckidresultsurldata-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/proxysniffer/{checkId}/results/{resultId}/errorlog ':
    ' get ':
      summary: Checks Proxy Sniffer Results Error Log
      description: Gets an error log of the given ProxySniffer check result.
      operationId: -checks-proxysniffer-checkid-results-resultid-errorlog-
      x-api-path-slug: checksproxysniffercheckidresultsresultiderrorlog-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - Proxy
  '/checks/url ':
    ' post ':
      summary: Checks URL
      description: Creates a new URL check (legacy version 1).
      operationId: -checks-url-
      x-api-path-slug: checksurl-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/checks/url-v2 ':
    ' post ':
      summary: Checks URL
      description: Creates a new URL check (version 2).
      operationId: -checks-url-v2-
      x-api-path-slug: checksurlv2-post
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/checks/url/{checkId} ':
    ' put ':
      summary: Checks URL
      description: Updates a URL check (legacy version 1).
      operationId: -checks-url-checkid-
      x-api-path-slug: checksurlcheckid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/checks/url-v2/{checkId} ':
    ' put ':
      summary: Checks URL
      description: Updates a URL check (version 2).
      operationId: -checks-url-v2-checkid-
      x-api-path-slug: checksurlv2checkid-put
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/checks/url/locations ':
    ' get ':
      summary: Checks URL Locations
      description: Gets a list of all locations that are available for URL (legacy
        version 1) checks.
      operationId: -checks-url-locations-
      x-api-path-slug: checksurllocations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/checks/url-v2/locations ':
    ' get ':
      summary: Checks URL Locations
      description: Gets a list of all locations that are available for URL (version
        2) checks.
      operationId: -checks-url-v2-locations-
      x-api-path-slug: checksurlv2locations-get
      responses:
        200:
          description: OK
      tags:
      - Checks
      - URL
  '/customers/{customerId} ':
    ' get ':
      summary: Customers
      description: Returns subcustomer by subcustomer's ID.
      operationId: -customers-customerid-
      x-api-path-slug: customerscustomerid-get
      responses:
        200:
          description: OK
      tags:
      - Customers
  '/customers ':
    ' post ':
      summary: Customers
      description: Creates customer.
      operationId: -customers-
      x-api-path-slug: customers-post
      responses:
        200:
          description: OK
      tags:
      - Customers
  '/customers/{customerId}/subscription ':
    ' put ':
      summary: Customers Subscription
      description: Updates customer's subscription.
      operationId: -customers-customerid-subscription-
      x-api-path-slug: customerscustomeridsubscription-put
      responses:
        200:
          description: OK
      tags:
      - Customers
  '/groups ':
    ' get ':
      summary: Groups
      description: Gets a hierarchy of all monitor groups that are visible to you
        as a user or a customer depending on the request context.
      operationId: -groups-
      x-api-path-slug: groups-get
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' post ':
      summary: Groups
      description: Creates a new monitor group.
      operationId: -groups-
      x-api-path-slug: groups-post
      responses:
        200:
          description: OK
      tags:
      - Groups
  '/groups/{groupId} ':
    ' put ':
      summary: Groups
      description: Updates a monitor group.
      operationId: -groups-groupid-
      x-api-path-slug: groupsgroupid-put
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' delete ':
      summary: Groups
      description: Deletes a monitor group by Id.
      operationId: -groups-groupid-
      x-api-path-slug: groupsgroupid-delete
      responses:
        200:
          description: OK
      tags:
      - Groups
  '/groups/{groupId}/checks ':
    ' get ':
      summary: Group Checks
      description: Gets a list of checks assigned to the monitor group.
      operationId: -groups-groupid-checks-
      x-api-path-slug: groupsgroupidchecks-get
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' post ':
      summary: Group Checks
      description: Assigns checks to the monitor group.
      operationId: -groups-groupid-checks-
      x-api-path-slug: groupsgroupidchecks-post
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' delete ':
      summary: Groups Checks
      description: Unassigns checks from the monitor group.
      operationId: -groups-groupid-checks-
      x-api-path-slug: groupsgroupidchecks-delete
      responses:
        200:
          description: OK
      tags:
      - Groups
  '/groups/{groupId}/users ':
    ' get ':
      summary: Groups Users
      description: Gets a list of users assigned to the monitor group.
      operationId: -groups-groupid-users-
      x-api-path-slug: groupsgroupidusers-get
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' post ':
      summary: Groups Users
      description: Assigns users to the monitor group.
      operationId: -groups-groupid-users-
      x-api-path-slug: groupsgroupidusers-post
      responses:
        200:
          description: OK
      tags:
      - Groups
    ' delete ':
      summary: Groups Users
      description: ""
      operationId: -groups-groupid-users-
      x-api-path-slug: groupsgroupidusers-delete
      responses:
        200:
          description: OK
      tags:
      - Groups
  /buckets/{bucketKey}/messages:
    delete:
      summary: Delete Buckets Messages
      description: Clear a bucket (remove all messages)..
      operationId: deleteBucketsBucketkeyMessages
      x-api-path-slug: bucketsbucketkeymessages-delete
      parameters:
      - in: path
        name: bucketKey
        description: Unique identifier for a bucket
      responses:
        200:
          description: OK
      tags:
      - Buckets
      - BucketKey
      - Messages
    get:
      summary: Get Buckets Messages
      description: Retrieve a list of messages in a bucket.
      operationId: getBucketsBucketkeyMessages
      x-api-path-slug: bucketsbucketkeymessages-get
      parameters:
      - in: query
        name: before
        description: Only return messages before the given Unix timestamp
      - in: path
        name: bucketKey
        description: Unique identifier for a bucket
      - in: query
        name: count
        description: Maxiumum number of messages to return
      - in: query
        name: since
        description: Only return messages after the given Unix timestamp
      responses:
        200:
          description: OK
      tags:
      - Buckets
      - BucketKey
      - Messages
    post:
      summary: Post Buckets Messages
      description: Create a message.
      operationId: postBucketsBucketkeyMessages
      x-api-path-slug: bucketsbucketkeymessages-post
      parameters:
      - in: body
        name: NewMessage
        schema:
          $ref: '#/definitions/holder'
      responses:
        200:
          description: OK
      tags:
      - Buckets
      - BucketKey
      - Messages
  /buckets/{bucketKey}/messages/{messageId}:
    get:
      summary: Get Buckets Messages Messageid
      description: Retrieve the details for a single message..
      operationId: getBucketsBucketkeyMessagesMessage
      x-api-path-slug: bucketsbucketkeymessagesmessageid-get
      parameters:
      - in: path
        name: bucketKey
        description: Unique identifier for a bucket
      - in: query
        name: messageId
        description: The unique identifier for this message
      responses:
        200:
          description: OK
      tags:
      - Buckets
      - BucketKey
      - Messages
      - MessageId
  '/messages?active={active}&amp;customerId={customerId} ':
    ' get ':
      summary: Get Messages
      description: Gets a list of UI messages. UI messages are used for user notifications
        on announcements/information/warnings.
      operationId: getMessagesActiveActive&amp;customerCustomer
      x-api-path-slug: messagesactiveactiveampcustomeridcustomerid-get
      responses:
        200:
          description: OK
      tags:
      - Messages?active=active&amp;customerId=customerId
  '/messages ':
    ' post ':
      summary: Post Messages
      description: Creates an UI message.
      operationId: postMessages
      x-api-path-slug: messages-post
      responses:
        200:
          description: OK
      tags:
      - Messages
  '/messages/{id} ':
    ' get ':
      summary: Get Messages
      description: Gets an existing UI message by Id.
      operationId: getMessages
      x-api-path-slug: messagesid-get
      responses:
        200:
          description: OK
      tags:
      - Messages
      - Id
    ' put ':
      summary: Put Messages
      description: Updates an existing UI message.
      operationId: putMessages
      x-api-path-slug: messagesid-put
      responses:
        200:
          description: OK
      tags:
      - Messages
      - Id
    ' delete ':
      summary: Delete Messages
      description: Deletes an existing UI message.
      operationId: deleteMessages
      x-api-path-slug: messagesid-delete
      responses:
        200:
          description: OK
      tags:
      - Messages
      - Id
  '/roles ':
    ' get ':
      summary: Get Roles
      description: Return user roles
      operationId: getRoles
      x-api-path-slug: roles-get
      responses:
        200:
          description: OK
      tags:
      - Roles
  '/scenarios/proxysniffer/dictionaries ':
    ' post ':
      summary: Scenarios Proxy Sniffer Dictionaries
      description: Adds Proxy Sniffer scenario custom dictionary.
      operationId: postScenariosProxysnifferDictionaries
      x-api-path-slug: scenariosproxysnifferdictionaries-post
      responses:
        200:
          description: OK
      tags:
      - Scenarios
      - Proxy
      - Sniffer
      - Dictionaries
  '/scenarios/proxysniffer/dictionaries/{dictionary_key} ':
    ' get ':
      summary: Scenarios Proxy Sniffer Dictionaries
      description: Gets a Proxy Sniffer scenario custom dictionary by dictionary key.
        Custom dictionary can contain any data used by Proxy Sniffer scripts which
        needs to be stored separately from scripts.
      operationId: getScenariosProxysnifferDictionariesDictionaryKey
      x-api-path-slug: scenariosproxysnifferdictionariesdictionary-key-get
      responses:
        200:
          description: OK
      tags:
      - Scenarios
      - Proxy
      - Sniffer
      - Dictionaries
    ' put ':
      summary: Scenarios Proxy Sniffer Dictionaries
      description: Updates Proxy Sniffer scenario custom dictionary.
      operationId: putScenariosProxysnifferDictionariesDictionaryKey
      x-api-path-slug: scenariosproxysnifferdictionariesdictionary-key-put
      responses:
        200:
          description: OK
      tags:
      - Scenarios
      - Proxy
      - Sniffer
      - Dictionaries
basePath: /
x-streamrank:
  polling_total_time_average: 0
  polling_size_download_average: 0
  streaming_total_time_average: 0
  streaming_size_download_average: 0
  change_yes: 0
  change_no: 0
  time_percentage: 0
  size_percentage: 0
  change_percentage: 0
  last_run: ""
  days_run: 0
  minute_run: 0
---