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-armessages-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 Armessages 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: armessages
paths:
  /api/v2/armessages/:
    get:
      operationId: armessages_list
      description: A viewset for ARmessage.
      parameters:
      - in: query
        name: mbox
        schema:
          type: string
      - in: query
        name: mbox__user
        schema:
          type: integer
      tags:
      - armessages
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ARMessage'
          description: ''
      summary: Armessages list
      x-summary-source: derived
    post:
      operationId: armessages_create
      description: A viewset for ARmessage.
      tags:
      - armessages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ARMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ARMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ARMessage'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARMessage'
          description: ''
      summary: Armessages create
      x-summary-source: derived
  /api/v2/armessages/{id}/:
    get:
      operationId: armessages_retrieve
      description: A viewset for ARmessage.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this a rmessage.
        required: true
      tags:
      - armessages
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARMessage'
          description: ''
      summary: Armessages retrieve
      x-summary-source: derived
    put:
      operationId: armessages_update
      description: A viewset for ARmessage.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this a rmessage.
        required: true
      tags:
      - armessages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ARMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ARMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ARMessage'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARMessage'
          description: ''
      summary: Armessages update
      x-summary-source: derived
    patch:
      operationId: armessages_partial_update
      description: A viewset for ARmessage.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this a rmessage.
        required: true
      tags:
      - armessages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedARMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedARMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedARMessage'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARMessage'
          description: ''
      summary: Armessages partial update
      x-summary-source: derived
components:
  schemas:
    PatchedARMessage:
      type: object
      description: A serializer for ARmessage.
      properties:
        id:
          type: integer
          readOnly: true
        subject:
          type: string
          description: The subject that will appear in sent emails
          maxLength: 255
        content:
          type: string
          description: The content that will appear in sent emails
        enabled:
          type: boolean
          description: Activate/Deactivate your auto reply
        fromdate:
          type: string
          format: date-time
        untildate:
          type:
          - string
          - 'null'
          format: date-time
        mbox:
          type: integer
    ARMessage:
      type: object
      description: A serializer for ARmessage.
      properties:
        id:
          type: integer
          readOnly: true
        subject:
          type: string
          description: The subject that will appear in sent emails
          maxLength: 255
        content:
          type: string
          description: The content that will appear in sent emails
        enabled:
          type: boolean
          description: Activate/Deactivate your auto reply
        fromdate:
          type: string
          format: date-time
        untildate:
          type:
          - string
          - 'null'
          format: date-time
        mbox:
          type: integer
      required:
      - content
      - id
      - mbox
      - subject
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"