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-migrations-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 Migrations 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: Migrations
paths:
  /api/v2/migrations/:
    get:
      operationId: migrations_list
      description: ViewSet class for Migration.
      parameters:
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Migrations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Migration'
          description: ''
      summary: Migrations list
      x-summary-source: derived
  /api/v2/migrations/{id}/:
    get:
      operationId: migrations_retrieve
      description: ViewSet class for Migration.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this migration.
        required: true
      tags:
      - Migrations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Migration'
          description: ''
      summary: Migrations retrieve
      x-summary-source: derived
    delete:
      operationId: migrations_destroy
      description: ViewSet class for Migration.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this migration.
        required: true
      tags:
      - Migrations
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Migrations destroy
      x-summary-source: derived
components:
  schemas:
    Nested:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        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
    Migration:
      type: object
      description: Serializer class for Migration.
      properties:
        id:
          type: integer
          readOnly: true
        provider:
          allOf:
          - $ref: '#/components/schemas/Nested'
          readOnly: true
        mailbox:
          $ref: '#/components/schemas/Mailbox'
        username:
          type: string
          maxLength: 254
      required:
      - id
      - mailbox
      - provider
      - username
    Mailbox:
      type: object
      description: Base mailbox serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        full_address:
          type: string
          format: email
        use_domain_quota:
          type: boolean
        quota:
          type: string
        message_limit:
          type:
          - integer
          - 'null'
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          title: Message sending limit
          description: Number of messages this mailbox can send per day
        quota_usage:
          type: integer
          readOnly: true
        is_send_only:
          type: boolean
        sent_messages_in_percent:
          type:
          - integer
          - 'null'
          description: Return number of sent messages as a percentage.
          readOnly: true
      required:
      - full_address
      - pk
      - quota_usage
      - sent_messages_in_percent
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"