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-aliases-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 Aliases 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: Aliases
paths:
  /api/v2/aliases/:
    get:
      operationId: aliases_list
      description: Viewset for Alias.
      parameters:
      - in: query
        name: domain
        schema:
          type: string
        description: The domain name
      - 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:
      - Aliases
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAliasList'
          description: ''
      summary: Aliases list
      x-summary-source: derived
    post:
      operationId: aliases_create
      description: Viewset for Alias.
      tags:
      - Aliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Alias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Alias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Alias'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases create
      x-summary-source: derived
  /api/v2/aliases/{id}/:
    get:
      operationId: aliases_retrieve
      description: Viewset for Alias.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alias.
        required: true
      tags:
      - Aliases
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases retrieve
      x-summary-source: derived
    put:
      operationId: aliases_update
      description: Viewset for Alias.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alias.
        required: true
      tags:
      - Aliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Alias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Alias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Alias'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases update
      x-summary-source: derived
    patch:
      operationId: aliases_partial_update
      description: Viewset for Alias.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alias.
        required: true
      tags:
      - Aliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAlias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAlias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAlias'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases partial update
      x-summary-source: derived
    delete:
      operationId: aliases_destroy
      description: Viewset for Alias.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this alias.
        required: true
      tags:
      - Aliases
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Aliases destroy
      x-summary-source: derived
  /api/v2/aliases/random_address/:
    get:
      operationId: aliases_random_address_retrieve
      description: Viewset for Alias.
      tags:
      - Aliases
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases random address retrieve
      x-summary-source: derived
  /api/v2/aliases/validate/:
    post:
      operationId: aliases_validate_create
      description: Validate given alias without creating it.
      tags:
      - Aliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Alias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Alias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Alias'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alias'
          description: ''
      summary: Aliases validate create
      x-summary-source: derived
components:
  schemas:
    Alias:
      type: object
      description: Alias serializer for v2 API.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        address:
          type: string
          format: email
        enabled:
          type: boolean
          description: Check to activate this alias
        recipients:
          type: array
          items:
            type: string
            format: email
          description: A list of recipient
        expire_at:
          type:
          - string
          - 'null'
          format: date-time
        description:
          type: string
        creation:
          type: string
          format: date-time
        last_modification:
          type: string
          format: date-time
          readOnly: true
      required:
      - address
      - last_modification
      - pk
      - recipients
    PatchedAlias:
      type: object
      description: Alias serializer for v2 API.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        address:
          type: string
          format: email
        enabled:
          type: boolean
          description: Check to activate this alias
        recipients:
          type: array
          items:
            type: string
            format: email
          description: A list of recipient
        expire_at:
          type:
          - string
          - 'null'
          format: date-time
        description:
          type: string
        creation:
          type: string
          format: date-time
        last_modification:
          type: string
          format: date-time
          readOnly: true
    PaginatedAliasList:
      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/Alias'
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"