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/autobrr:autobrr-notifications-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

openapi: 3.2.0
info:
  title: qui Notifications API
  description: 'qui API for managing multiple qBittorrent instances.

    If allowedHosts is configured, a missing, invalid, or unlisted received Host

    returns HTTP 400 before authentication or routing. X-Forwarded-Host is ignored.

    Request ports do not affect matching. Only direct loopback GET and HEAD

    requests to /health, /healthz/readiness, and /healthz/liveness bypass the list.


    For automation create and update requests, set `conditions.category.enabled` to `true`

    and `conditions.category.category` to an empty string to remove the torrent category.

    Set `conditions.category.enabled` to `false` to disable the category action.'
  version: 1.0.0
  license:
    name: GPL-2.0-or-later
    url: https://opensource.org/licenses/GPL-2.0
servers:
- url: http://localhost:7476
  description: Local development server
- url: /
  description: Current server
security:
- ApiKeyAuth: []
- SessionAuth: []
tags:
- name: Notifications
  description: Notification-related endpoints for targets and events
paths:
  /api/notifications/events:
    get:
      tags:
      - Notifications
      summary: List notification events
      description: Get supported notification event types
      responses:
        '200':
          description: Notification event types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationEventDefinition'
      operationId: getApiNotificationsEvents
      x-operation-id-source: derived
  /api/notifications/targets:
    get:
      tags:
      - Notifications
      summary: List notification targets
      description: Get configured notification targets
      responses:
        '200':
          description: List of notification targets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationTarget'
      operationId: getApiNotificationsTargets
      x-operation-id-source: derived
    post:
      tags:
      - Notifications
      summary: Create notification target
      description: Add a new notification target
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTargetRequest'
      responses:
        '201':
          description: Notification target created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTarget'
        '400':
          description: Invalid request
        '500':
          description: Internal server error
      operationId: postApiNotificationsTargets
      x-operation-id-source: derived
  /api/notifications/targets/{id}:
    put:
      tags:
      - Notifications
      summary: Update notification target
      description: Update an existing notification target
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTargetRequest'
      responses:
        '200':
          description: Notification target updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTarget'
        '400':
          description: Invalid request
        '404':
          description: Notification target not found
        '500':
          description: Internal server error
      operationId: putApiNotificationsTargetsById
      x-operation-id-source: derived
    delete:
      tags:
      - Notifications
      summary: Delete notification target
      description: Delete a notification target
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Notification target deleted
        '404':
          description: Notification target not found
        '500':
          description: Internal server error
      operationId: deleteApiNotificationsTargetsById
      x-operation-id-source: derived
  /api/notifications/targets/{id}/test:
    post:
      tags:
      - Notifications
      summary: Test notification target
      description: Send a test notification to a target
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTestRequest'
      responses:
        '200':
          description: Test notification sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
        '400':
          description: Invalid request
        '404':
          description: Notification target not found
        '502':
          description: Failed to send test notification
        '500':
          description: Internal server error
      operationId: postApiNotificationsTargetsByIdTest
      x-operation-id-source: derived
components:
  schemas:
    NotificationTarget:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        url:
          type: string
          format: uri
        enabled:
          type: boolean
        eventTypes:
          type: array
          items:
            type: string
          description: List of event types this target subscribes to (empty means all events)
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    NotificationEventDefinition:
      type: object
      properties:
        type:
          type: string
          description: Notification event identifier
        label:
          type: string
          description: Human-readable event label
        description:
          type: string
          description: Event description
    NotificationTargetRequest:
      type: object
      required:
      - name
      - url
      properties:
        name:
          type: string
        url:
          type: string
          format: uri
        enabled:
          type: boolean
        eventTypes:
          type: array
          items:
            type: string
          description: List of event types this target subscribes to (empty means all events)
    NotificationTestRequest:
      type: object
      properties:
        title:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    ApiKeyQuery:
      type: apiKey
      in: query
      name: apikey
      description: API key via query parameter for external webhook integrations
    SessionAuth:
      type: apiKey
      in: cookie
      name: qui_user_session
      description: 'Browser session cookie set by the qui web UI. POST, PUT, PATCH, and DELETE

        requests authenticated by this cookie must also send an `X-Requested-With`

        header. Other clients should use an API key.

        '