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-email-providers-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 Email Providers 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: email-providers
paths:
  /api/v2/email-providers/:
    get:
      operationId: email_providers_list
      description: ViewSet class for EmailProvider.
      parameters:
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - email-providers
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers list
      x-summary-source: derived
    post:
      operationId: email_providers_create
      description: ViewSet class for EmailProvider.
      tags:
      - email-providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailProvider'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers create
      x-summary-source: derived
  /api/v2/email-providers/{id}/:
    get:
      operationId: email_providers_retrieve
      description: ViewSet class for EmailProvider.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this email provider.
        required: true
      tags:
      - email-providers
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers retrieve
      x-summary-source: derived
    put:
      operationId: email_providers_update
      description: ViewSet class for EmailProvider.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this email provider.
        required: true
      tags:
      - email-providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailProvider'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers update
      x-summary-source: derived
    patch:
      operationId: email_providers_partial_update
      description: ViewSet class for EmailProvider.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this email provider.
        required: true
      tags:
      - email-providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEmailProvider'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEmailProvider'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEmailProvider'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers partial update
      x-summary-source: derived
    delete:
      operationId: email_providers_destroy
      description: ViewSet class for EmailProvider.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this email provider.
        required: true
      tags:
      - email-providers
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Email providers destroy
      x-summary-source: derived
  /api/v2/email-providers/check_associated_domain/:
    post:
      operationId: email_providers_check_associated_domain_create
      description: 'check that the associated domain is either the same as the provider,

        or if a local domain already exists.

        This is to prevent errros on setup.'
      tags:
      - email-providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailProvider'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers check associated domain create
      x-summary-source: derived
  /api/v2/email-providers/check_connection/:
    post:
      operationId: email_providers_check_connection_create
      description: check that provided information allow connection to imap server.
      tags:
      - email-providers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmailProvider'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmailProvider'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailProvider'
          description: ''
      summary: Email providers check connection create
      x-summary-source: derived
components:
  schemas:
    EmailProvider:
      type: object
      description: Serializer class for EmailProvider.
      properties:
        id:
          type: integer
          readOnly: true
        domains:
          type: array
          items:
            $ref: '#/components/schemas/EmailProviderDomain'
        name:
          type: string
          maxLength: 50
        address:
          type: string
          maxLength: 200
        port:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
        secured:
          type: boolean
      required:
      - address
      - id
      - name
    PatchedEmailProvider:
      type: object
      description: Serializer class for EmailProvider.
      properties:
        id:
          type: integer
          readOnly: true
        domains:
          type: array
          items:
            $ref: '#/components/schemas/EmailProviderDomain'
        name:
          type: string
          maxLength: 50
        address:
          type: string
          maxLength: 200
        port:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
        secured:
          type: boolean
    EmailProviderDomain:
      type: object
      description: Serializer class for EmailProviderDomain.
      properties:
        id:
          type: integer
        name:
          type: string
          maxLength: 100
        new_domain:
          type:
          - integer
          - 'null'
      required:
      - name
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"