@itentialopensource/adapter-netrounds/report/adapter-openapi.yaml

[Deprecated] This adapter integrates with system described as: NetRounds

openapi: 3.0.0
info:
  title: Netrounds Orchestration REST API
  description: '<h4>   <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md" target="_blank">       Swagger/OpenAPI specification 2.0   </a>    is used for this API.</h4><h4>   The full schema is available at:    <a href="/rest/apispec_1.json" target="_blank">/rest/apispec_1.json</a>.</h4><p>   This schema can be used to generate client code automatically, see the    <a href="https://editor.swagger.io/" target="_blank">Swagger Editor</a>    for some examples.</p>'
  contact: {}
  version: '1.0'
servers:
- url: http://app.netrounds.com/rest
  variables: {}
paths:
  /accounts/{account}/alarm_emails/:
    get:
      tags:
      - alarm_email
      summary: list_alarm_emails
      description: This will list existing alarm emails.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/email_settings
      operationId: list_alarm_emails
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed alarm emails successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmEmailListSchema'
        '403':
          description: Missing permission to list alarm emails
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - alarm_email
      summary: create_alarm_emails
      description: This will create the alarm emails.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/email_settings
      operationId: create_alarm_emails
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmEmailSchema'
        required: false
      responses:
        '201':
          description: Alarm emails object was successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmEmailSchema'
        '400':
          description: Request incorrectly formatted
          headers: {}
          content: {}
        '403':
          description: Missing permission to create alarm emails
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/alarm_emails/{alarm_emails_id}/:
    delete:
      tags:
      - alarm_email
      summary: delete_alarm_emails
      description: This will delete alarm emails.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/email_settings
      operationId: delete_alarm_emails
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_emails_id
        in: path
        description: ID of the email list
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The alarm emails object has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete alarm emails
          headers: {}
          content: {}
        '404':
          description: Alarm emails object does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - alarm_email
      summary: get_alarm_emails
      description: This will return the alarm emails.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/email_settings
      operationId: get_alarm_emails
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_emails_id
        in: path
        description: ID of the email list
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The alarm emails object was successfully returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmEmailSchema'
        '403':
          description: Missing permission to get alarm emails
          headers: {}
          content: {}
        '404':
          description: Alarm emails object does not exist
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - alarm_email
      summary: update_alarm_emails
      description: This will modify alarm emails.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/email_settings
      operationId: update_alarm_emails
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_emails_id
        in: path
        description: ID of the email list
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmEmailSchema'
        required: false
      responses:
        '200':
          description: The alarm emails object has been modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmEmailSchema'
        '403':
          description: Missing permission to update alarm emails
          headers: {}
          content: {}
        '404':
          description: Alarm emails object does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/alarm_templates/:
    get:
      tags:
      - alarm_template
      summary: list_alarm_templates
      description: This will list existing Alarm Templates.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/alarm_template_settings
      operationId: list_alarm_templates
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed Alarm Templates successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmTemplateListSchema'
        '403':
          description: Missing permission to list Alarm Templates
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - alarm_template
      summary: create_alarm_templates
      description: This will create an Alarm Template.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/alarm_template_settings
      operationId: create_alarm_templates
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmTemplateSchema'
        required: false
      responses:
        '201':
          description: Alarm Template created successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmTemplateSchema'
        '400':
          description: Request incorrectly formatted
          headers: {}
          content: {}
        '403':
          description: Missing permission to create an Alarm Template
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/alarm_templates/{alarm_template_id}/:
    delete:
      tags:
      - alarm_template
      summary: delete_alarm_template
      description: This will delete an Alarm Template.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/alarm_template_settings
      operationId: delete_alarm_template
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_template_id
        in: path
        description: Alarm Template id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Alarm Template object has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete an Alarm Template
          headers: {}
          content: {}
        '404':
          description: Alarm Template object does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - alarm_template
      summary: get_alarm_template
      description: This will return an Alarm Template.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/alarm_template_settings
      operationId: get_alarm_template
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_template_id
        in: path
        description: Alarm Template id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Alarm Template returned successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmTemplateSchema'
        '403':
          description: Missing permission to get Alarm Template
          headers: {}
          content: {}
        '404':
          description: Alarm Template object does not exist
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - alarm_template
      summary: update_alarm_template
      description: This will modify an Alarm Template.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/alarm_template_settings
      operationId: update_alarm_template
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_template_id
        in: path
        description: Alarm Template id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmTemplateSchema'
        required: false
      responses:
        '200':
          description: Alarm Template object has been modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmTemplateSchema'
        '403':
          description: Missing permission to update an Alarm Template
          headers: {}
          content: {}
        '404':
          description: Alarm Template object does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/alarms/:
    get:
      tags:
      - alarm
      summary: list_alarms
      description: This will list existing alarms.<br/><br/>An active config is being returned for this resource. This is the config actually used to trigger an alarm.<br/>It consists of parameters from an alarm template overriden by values from an alarm config.
      externalDocs:
        url: https://localhost/system/support/topic/alarms/dashboard
      operationId: list_alarms
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: created_timespan_start
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC.
        style: form
        explode: true
        schema:
          type: string
      - name: created_timespan_end
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC.
        style: form
        explode: true
        schema:
          type: string
      - name: cleared_timespan_start
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC.
        style: form
        explode: true
        schema:
          type: string
      - name: cleared_timespan_end
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC.
        style: form
        explode: true
        schema:
          type: string
      - name: suppressed
        in: query
        description: When set to true then suppressed alarms will be returned
        style: form
        explode: true
        schema:
          type: boolean
      - name: interface_name
        in: query
        description: Returns alarms with this value in interface_name field.
        style: form
        explode: true
        schema:
          type: string
      - name: test_agent
        in: query
        description: Id of test agent for which alarms should be filtered out.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: task
        in: query
        description: Id of task for which alarms should be filtered out.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed alarms successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmListSchema'
        '403':
          description: Missing permission to list alarms
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/alarms/{alarm_id}/:
    delete:
      tags:
      - alarm
      summary: delete_alarm
      description: This will delete alarm.
      externalDocs:
        url: https://localhost/system/support/topic/alarms/dashboard
      operationId: delete_alarm
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_id
        in: path
        description: Alarm id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The alarm object has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete alarm
          headers: {}
          content: {}
        '404':
          description: Alarm object does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - alarm
      summary: get_alarm
      description: This will return the alarm.<br/><br/>An active config is being returned for this resource. This is the config actually used to trigger an alarm.<br/>It consists of parameters from an alarm template overriden by values from an alarm config.
      externalDocs:
        url: https://localhost/system/support/topic/alarms/dashboard
      operationId: get_alarm
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_id
        in: path
        description: Alarm id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The alarm object was successfully returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmSchema'
        '403':
          description: Missing permission to get alarm
          headers: {}
          content: {}
        '404':
          description: Alarm object does not exist
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - alarm
      summary: update_alarm
      description: This will suppress alarm.
      externalDocs:
        url: https://localhost/system/support/topic/alarms/dashboard
      operationId: update_alarm
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: alarm_id
        in: path
        description: Alarm id
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmSchema'
        required: false
      responses:
        '200':
          description: The alarm object has been suppressed
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmSchema'
        '403':
          description: Missing permission to update alarm
          headers: {}
          content: {}
        '404':
          description: Alarm object does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/iptv_channels/:
    get:
      tags:
      - iptv_channel
      summary: list_iptv_channels
      description: This will list the IPTV Channels
      externalDocs:
        url: https://localhost/system/support/topic/task_types/iptv/intro_intro_iptv
      operationId: list_iptv_channels
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed IPTV Channels successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPTVChannelListSchema'
        '403':
          description: Missing permission to list IPTV Channels
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - iptv_channel
      summary: create_iptv_channel
      description: This will create the IPTV Channel
      externalDocs:
        url: https://localhost/system/support/topic/task_types/iptv/intro_intro_iptv
      operationId: create_iptv_channel
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPTVChannelSchema'
        required: false
      responses:
        '201':
          description: The IPTV Channel was successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPTVChannelSchema'
        '400':
          description: Request incorrectly formatted
          headers: {}
          content: {}
        '403':
          description: Missing permission to create IPTV Channel
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/iptv_channels/{iptv_id}/:
    delete:
      tags:
      - iptv_channel
      summary: delete_iptv_channel
      description: This will delete the IPTV Channel
      externalDocs:
        url: https://localhost/system/support/topic/task_types/iptv/intro_intro_iptv
      operationId: delete_iptv_channel
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: iptv_id
        in: path
        description: ID of the IPTV channel
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The IPTV Channel has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete IPTV Channel
          headers: {}
          content: {}
        '404':
          description: IPTV Channel does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - iptv_channel
      summary: get_iptv_channel
      description: This will return the IPTV Channel
      externalDocs:
        url: https://localhost/system/support/topic/task_types/iptv/intro_intro_iptv
      operationId: get_iptv_channel
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: iptv_id
        in: path
        description: ID of the IPTV channel
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The IPTV Channel was successfully returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPTVChannelSchema'
        '403':
          description: Missing permission to get IPTV Channel
          headers: {}
          content: {}
        '404':
          description: IPTV Channel does not exist
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - iptv_channel
      summary: update_iptv_channel
      description: This will modify the IPTV Channel
      externalDocs:
        url: https://localhost/system/support/topic/task_types/iptv/intro_intro_iptv
      operationId: update_iptv_channel
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: iptv_id
        in: path
        description: ID of the IPTV channel
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPTVChannelSchema'
        required: false
      responses:
        '200':
          description: The IPTV Channel has been modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPTVChannelSchema'
        '403':
          description: Missing permission to update IPTV Channel
          headers: {}
          content: {}
        '404':
          description: IPTV Channel does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/monitor_templates/:
    get:
      tags:
      - monitor_template
      summary: list_monitor_templates
      description: This will list the Monitor Templates
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/templates
      operationId: list_monitor_templates
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed Monitor Templates successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorTemplateListSchema'
        '403':
          description: Missing permission to list Monitor Templates
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/monitor_templates/{template_id}/:
    get:
      tags:
      - monitor_template
      summary: get_monitor_template
      description: This will return the Monitor Template
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/templates
      operationId: get_monitor_template
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: template_id
        in: path
        description: Id of the Monitor template
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The Monitor Template was successfully returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorTemplateSchema'
        '403':
          description: Missing permission to get a Monitor Template
          headers: {}
          content: {}
        '404':
          description: The Monitor Template does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/monitors/:
    get:
      tags:
      - monitor
      summary: list_monitors
      description: This will list all Monitors with their SLA
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: list_monitors
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Listed Monitors with SLA successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorListSchema'
        '403':
          description: Missing a permission to get a Monitor with SLA
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - monitor
      summary: create_monitor
      description: This will create Monitor from template
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: create_monitor
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorFromTemplateSchema'
        required: false
      responses:
        '201':
          description: Monitor was successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorCreatedSchema'
        '400':
          description: Request incorrectly formatted
          headers: {}
          content: {}
        '403':
          description: Missing permission to create Monitor
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/monitors/{monitor_id}/:
    delete:
      tags:
      - monitor
      summary: delete_monitor
      description: This will delete the Monitor
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: delete_monitor
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: monitor_id
        in: path
        description: Id of the Monitor
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The Monitor has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete Monitor
          headers: {}
          content: {}
        '404':
          description: Monitor does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - monitor
      summary: get_monitor
      description: This will get a Monitor and its SLA.<br/><br/>Periodic Tests are run as part of a Monitor. If a **Task** has a `task_type` value of `periodic`<br/>the `results` list will always be empty.<br/>Instead there's an `executions` list that contains a list of **Test IDs** with<br/>each run of the tests, which contains the actual results.
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: get_monitor
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: monitor_id
        in: path
        description: Id of the Monitor
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      - name: resolution
        in: query
        description: Resolution of the results in seconds. Value should be greater than 0.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: with_detailed_metrics
        in: query
        description: Set to true to get response with metrics.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
      - name: with_metrics_avg
        in: query
        description: Set to true to get response with metrics averages.
        style: form
        explode: true
        schema:
          type: boolean
          default: true
          example: true
      - name: with_other_results
        in: query
        description: Set to true to get addition results.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: Got a Monitor and its SLA successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorDetailSchema'
        '403':
          description: Missing permission to get a Monitor and its SLA
          headers: {}
          content: {}
      deprecated: false
    patch:
      tags:
      - monitor
      summary: patch_monitor
      description: Update Monitor's name and description, or start/stop it
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: patch_monitor
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: monitor_id
        in: path
        description: Id of the Monitor
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorPatchSchema'
        required: false
      responses:
        '200':
          description: Monitor has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorPatchSchema'
        '403':
          description: Missing permission to update a Monitor
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - monitor
      summary: update_monitor
      description: Update Monitor's name, description, alarm_config, or start/stop it
      externalDocs:
        url: https://localhost/system/support/topic/work_testmon/buildmon
      operationId: update_monitor
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: monitor_id
        in: path
        description: Id of the Monitor
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitorPutSchema'
        required: false
      responses:
        '200':
          description: Monitor has been updated
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorPutSchema'
        '403':
          description: Missing permission to update a Monitor
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/monitors/{monitor_id}/pdf_report:
    get:
      tags:
      - monitor
      summary: get_monitor_pdfreport
      description: This will download a Monitor PDF report file.<br/>
      operationId: get_monitor_pdfreport
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: monitor_id
        in: path
        description: Id of the Monitor
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      - name: end
        in: query
        description: ISO-8601 date format (yyyy-mm-ddThh:MM:ss.sZ) e.g. 2017-01-02T03:04:56.0Z. This has to be provided in UTC. By default 15 minutes period will be used.
        style: form
        explode: true
        schema:
          type: string
      - name: worst_num
        in: query
        description: The minimum count of result in the periodic report.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 5
          example: 5
      - name: group
        in: query
        description: True means it will group result in the periodic report.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
      - name: graphs
        in: query
        description: True means the graph will be shown in the periodic report.
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
      responses:
        '200':
          description: Download a Monitor PDF report
          headers: {}
          content:
            application/pdf:
              schema:
                description: Download a Monitor PDF report
        '403':
          description: Missing permission to get a Monitor PDF report
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/sip_accounts/:
    get:
      tags:
      - sip_account
      summary: list_sip_accounts
      description: This will list SIP Accounts
      externalDocs:
        url: https://localhost/system/support/topic/account/sip_setup
      operationId: list_sip_accounts
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed SIP Accounts successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPAccountListSchema'
        '403':
          description: Missing permission to list SIP Accounts
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - sip_account
      summary: create_sip_account
      description: This will create the SIP Account
      externalDocs:
        url: https://localhost/system/support/topic/account/sip_setup
      operationId: create_sip_account
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIPAccountSchema'
        required: false
      responses:
        '201':
          description: The SIP Account was successfully created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPAccountSchema'
        '400':
          description: Request incorrectly formatted
          headers: {}
          content: {}
        '403':
          description: Missing permission to create SIP Account
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/sip_accounts/{sip_id}/:
    delete:
      tags:
      - sip_account
      summary: delete_sip_account
      description: This will delete the SIP Account
      externalDocs:
        url: https://localhost/system/support/topic/account/sip_setup
      operationId: delete_sip_account
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: sip_id
        in: path
        description: ID of the SIP account
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: The SIP Account has been deleted
          headers: {}
          content: {}
        '403':
          description: Missing permission to delete SIP Account
          headers: {}
          content: {}
        '404':
          description: SIP Account does not exist
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - sip_account
      summary: get_sip_account
      description: This will return the SIP Account
      externalDocs:
        url: https://localhost/system/support/topic/account/sip_setup
      operationId: get_sip_account
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: sip_id
        in: path
        description: ID of the SIP account
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The SIP Account was successfully returned
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPAccountSchema'
        '403':
          description: Missing permission to get SIP Account
          headers: {}
          content: {}
        '404':
          description: SIP Account does not exist
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - sip_account
      summary: update_sip_account
      description: This will modify the SIP Account
      externalDocs:
        url: https://localhost/system/support/topic/account/sip_setup
      operationId: update_sip_account
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: sip_id
        in: path
        description: ID of the SIP account
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIPAccountSchema'
        required: false
      responses:
        '200':
          description: The SIP Account has been modified
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIPAccountSchema'
        '403':
          description: Missing permission to update SIP Account
          headers: {}
          content: {}
        '404':
          description: SIP Account does not exist
          headers: {}
          content: {}
      deprecated: false
  /accounts/{account}/snmp_managers/:
    get:
      tags:
      - snmp_manager
      summary: list_snmp_managers
      description: This will list existing SNMP managers.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/snmp_manager_settings
      operationId: list_snmp_managers
      parameters:
      - name: account
        in: path
        description: The account to perform the action on
        required: true
        style: simple
        schema:
          type: string
      - name: limit
        in: query
        description: How many elements should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: From which element list should be returned
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Listed SNMP managers successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SNMPManagerListSchema'
        '403':
          description: Missing permission to list SNMP managers
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - snmp_manager
      summary: create_snmp_manager
      description: This will create the SNMP manager.
      externalDocs:
        url: https://localhost/system/support/topic/account/alarm_setup/snmp_manager_settings
      operationId: create_snmp_manager
      parameters: