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/modoboa:modoboa-alarms-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: Modoboa Alarms API
  version: v2
servers:
- url: https://demo.modoboa.org/api/schema-v2/
  description: Remote Demo server
- url: https://localhost:5000/api/schema-v2/
  description: Local server
tags:
- name: Alarms
paths:
  /api/v2/alarms/:
    get:
      operationId: alarms_list
      description: Viewset for Alarm.
      parameters:
      - in: query
        name: created
        schema:
          type: string
          format: date-time
      - in: query
        name: min_date
        schema:
          type: string
          format: date-time
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Alarms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAlarmList'
          description: ''
      summary: Alarms list
      x-summary-source: derived
  /api/v2/alarms/{id}/:
    get:
      operationId: alarms_retrieve
      description: Viewset for Alarm.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alarm.
        required: true
      tags:
      - Alarms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
          description: ''
      summary: Alarms retrieve
      x-summary-source: derived
    delete:
      operationId: alarms_destroy
      description: Viewset for Alarm.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alarm.
        required: true
      tags:
      - Alarms
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Alarms destroy
      x-summary-source: derived
  /api/v2/alarms/{id}/switch/:
    patch:
      operationId: alarms_switch_partial_update
      description: Custom update method that switch status of an alarm.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alarm.
        required: true
      tags:
      - Alarms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAlarmSwitchStatus'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAlarmSwitchStatus'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAlarmSwitchStatus'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmSwitchStatus'
          description: ''
      summary: Alarms switch partial update
      x-summary-source: derived
  /api/v2/alarms/bulk_delete/:
    post:
      operationId: alarms_bulk_delete_create
      description: Delete multiple alarms at the same time.
      tags:
      - Alarms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmBulkDelete'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AlarmBulkDelete'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AlarmBulkDelete'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlarmBulkDelete'
          description: ''
      summary: Alarms bulk delete create
      x-summary-source: derived
components:
  schemas:
    Alarm:
      type: object
      description: Serializer for Alarm related endpoints.
      properties:
        id:
          type: integer
          readOnly: true
        domain:
          allOf:
          - $ref: '#/components/schemas/AlarmDomain'
          readOnly: true
        mailbox:
          allOf:
          - $ref: '#/components/schemas/AlarmMailbox'
          readOnly: true
        created:
          type: string
          format: date-time
        closed:
          type:
          - string
          - 'null'
          format: date-time
        status:
          allOf:
          - $ref: '#/components/schemas/AlarmStatusEnum'
          minimum: -9223372036854775808
          maximum: 9223372036854775807
        title:
          type: string
        internal_name:
          type: string
          maxLength: 120
      required:
      - domain
      - id
      - internal_name
      - mailbox
      - title
    PatchedAlarmSwitchStatus:
      type: object
      description: Serializer to switch the status of an Alarm.
      properties:
        status:
          type: integer
    AlarmSwitchStatus:
      type: object
      description: Serializer to switch the status of an Alarm.
      properties:
        status:
          type: integer
      required:
      - status
    AlarmBulkDelete:
      type: object
      properties:
        ids:
          type: array
          items:
            type: integer
      required:
      - ids
    AlarmStatusEnum:
      enum:
      - 1
      - 2
      type: integer
      description: '* `1` - Opened

        * `2` - Closed'
    PaginatedAlarmList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Alarm'
    AlarmMailbox:
      type: object
      description: Minimal mailbox representation exposed through alarms.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        address:
          type: string
          description: Mailbox address (without the @domain.tld part)
          maxLength: 252
      required:
      - address
      - pk
    AlarmDomain:
      type: object
      description: Minimal domain representation exposed through alarms.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The domain name
          maxLength: 253
      required:
      - name
      - pk
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"