Unitrends

Unitrends BackupIqAlerts API

The BackupIqAlerts API from Unitrends — 1 operation(s) for backupiqalerts.

GitHub OpenAPI

Operations 1

GET /v1/backupiq/alerts Returns a list of BackupIQ alerts based on filtering, ordering and paging criteria.

Documentation

📖
APIReference
https://apidoc-public-api.backup.net/swagger-ui-v2/index.html
📖
GettingStarted
https://help.unitrends.kaseya.com/uniview-help/Content/MSP/public-api.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/unitrends/refs/heads/main/openapi/unitrends-backupiqalerts-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/unitrends-backupiqalerts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

unitrends-backupiqalerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Public Agents Backup Iq Alerts API
  description: Description of Public API for Unitrends MSP.
  version: public_api-v1
servers:
- url: https://public-api.backup.net
security:
- Bearer: []
tags:
- name: BackupIqAlerts
paths:
  /v1/backupiq/alerts:
    get:
      tags:
      - BackupIqAlerts
      summary: Returns a list of BackupIQ alerts based on filtering, ordering and paging criteria.
      description: Visibility is restricted by tenant which issued credentials for access.
      parameters:
      - name: type
        in: query
        description: The type of the alert.
        required: true
        schema:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertTypeModel'
      - name: severity
        in: query
        description: The severity of the alert.
        schema:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertSeverityModel'
      - name: is_muted
        in: query
        description: 'Indicates that alert is muted on UI by settings of alerts specified on the portal.

          Muted alerts are not displayed on the portal UI.

          API returns not muted alerts by default.'
        schema:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.MutedFilterModel'
      - name: customer_id
        in: query
        description: The id of the customer in UUID format.
        schema:
          type: string
          format: uuid
      - name: customer_name
        in: query
        description: The name of the customer. All of the customers that contain passed parameter will be in filtered result.
        schema:
          type: string
      - name: asset_tag
        in: query
        description: The id of the appliance.
        schema:
          type: string
      - name: appliance_name
        in: query
        description: The name of the appliance. All of the appliances that contain passed parameter will be in filtered result.
        schema:
          type: string
      - name: asset_name
        in: query
        description: The name of the asset. All of the asset that contain passed parameter will be in filtered result.
        schema:
          type: string
      - name: asset_key
        in: query
        description: The unique identifier of the asset.
        schema:
          type: string
          format: uuid
      - name: job_name
        in: query
        description: The name of the job. All of the jobs that contain passed parameter will be in filtered result.
        schema:
          type: string
      - name: job_type
        in: query
        description: The type of the job. All of the jobs that contain passed parameter will be in filtered result.
        schema:
          type: string
      - name: is_dismissed
        in: query
        description: 'Flag that indicates dismiss status of an alert. It means whether a user dismissed an alert in BackupIQ interface.

          The absence of the parameter leads to both dismissed and not dismissed alerts in the filtered result.'
        schema:
          type: boolean
      - name: order_by
        in: query
        description: The ordering field.
        schema:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.OrderColumnModel'
      - name: order_direction
        in: query
        description: Direction of the order. E.g. "asc", "desc".
        schema:
          type: string
      - name: created_time_direction
        in: query
        description: Direction of ordering by created_time field, which always the second ordering field. E.g. "asc", "desc".
        schema:
          type: string
      - name: page_number
        in: query
        description: The page number. Default is 1.
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
      - name: page_size
        in: query
        description: The page size. Default is 50.
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          headers:
            Paging-Page-Size:
              description: Current page size.
              schema:
                type: integer
            Paging-Page-Number:
              description: Current page number.
              schema:
                type: integer
            Paging-Total-Records:
              description: Total amount of records.
              schema:
                type: integer
            Paging-Total-Pages:
              description: Total count of pages.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                  - $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.AlertModel'
                  - $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.JobAlertModel'
                  - $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.ConditionalAlertModel'
components:
  schemas:
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.JobAlertModel:
      allOf:
      - $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.AlertModel'
      - type: object
        properties:
          job_name:
            type:
            - string
            - 'null'
            description: The name of the job
            example: Full Backup Job 1
          job_type:
            type:
            - string
            - 'null'
            description: The type of the job
            example: Backup
        additionalProperties: false
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.ConditionalAlertModel:
      allOf:
      - $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.AlertModel'
      - type: object
        properties:
          interrogation_message:
            type:
            - string
            - 'null'
            description: The result of interrogation for alert underlying reason.
            example: Appliance is offline. Backups have not been running as a result. Open appliance details page and check that the appliance is powered on and connected to the network. If the problem persists, please open a support case.
        additionalProperties: false
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertTypeModel:
      enum:
      - alert
      - job
      - conditional
      - helix
      type: string
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.AlertModel:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertTypeModel'
        appliance_name:
          type:
          - string
          - 'null'
          description: The name of the appliance.
          example: Appliance 1
        asset_tag:
          type:
          - string
          - 'null'
          description: The id of the appliance.
          example: 8008-100-70130
        customer_id:
          type: string
          description: The id of the customer in UUID format.
          format: uuid
          example: d28a556c-d8de-48f9-8a64-90fdf03ec4d0
        customer_name:
          type:
          - string
          - 'null'
          description: The name of the customer.
          example: John Doe
        message:
          type:
          - string
          - 'null'
          description: The alert message.
          example: The asset backup was not created for the last 1 hour(s).
        severity:
          $ref: '#/components/schemas/MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertSeverityModel'
        created_time:
          type: string
          description: The alert creation time.
          format: date-time
          example: '2021-06-07T13:28:32.200Z'
        is_dismissed:
          type: boolean
          description: Flag that indicates dismiss status of an alert. It means whether a user dismissed an alert in BackupIQ interface.
          example: true
        is_muted:
          type: boolean
          description: Flag indicates that alert is muted on UI by settings of alerts specified on the portal.
          example: true
      additionalProperties: false
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.MutedFilterModel:
      enum:
      - 'false'
      - 'true'
      - all
      type: string
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.BackupIqAlertSeverityModel:
      enum:
      - alarm
      - critical
      - warning
      type: string
    MSP.Portal.PublicApi.Api.Controllers.BackupIqAlerts.Models.OrderColumnModel:
      enum:
      - type
      - severity
      - customer_id
      - customer_name
      - asset_tag
      - appliance_name
      - asset_name
      - asset_key
      - job_name
      - job_type
      - is_dismissed
      type: string
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'JWT Authorization header using the Bearer scheme. Example value: "Bearer {token}"'
      name: Authorization
      in: header