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-domainaliases-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 Domainaliases 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: domainaliases
paths:
  /api/v2/domainaliases/:
    get:
      operationId: domainaliases_list
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      tags:
      - domainaliases
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainAlias'
            text/csv:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainAlias'
          description: ''
      summary: Domainaliases list
      x-summary-source: derived
    post:
      operationId: domainaliases_create
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      tags:
      - domainaliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainAlias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainAlias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DomainAlias'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAlias'
            text/csv:
              schema:
                $ref: '#/components/schemas/DomainAlias'
          description: ''
      summary: Domainaliases create
      x-summary-source: derived
  /api/v2/domainaliases/{id}/:
    get:
      operationId: domainaliases_retrieve
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - domainaliases
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAlias'
            text/csv:
              schema:
                $ref: '#/components/schemas/DomainAlias'
          description: ''
      summary: Domainaliases retrieve
      x-summary-source: derived
    put:
      operationId: domainaliases_update
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - domainaliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainAlias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainAlias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DomainAlias'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAlias'
            text/csv:
              schema:
                $ref: '#/components/schemas/DomainAlias'
          description: ''
      summary: Domainaliases update
      x-summary-source: derived
    patch:
      operationId: domainaliases_partial_update
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - domainaliases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDomainAlias'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDomainAlias'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDomainAlias'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAlias'
            text/csv:
              schema:
                $ref: '#/components/schemas/DomainAlias'
          description: ''
      summary: Domainaliases partial update
      x-summary-source: derived
    delete:
      operationId: domainaliases_destroy
      description: ViewSet for DomainAlias.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - csv
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - domainaliases
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Domainaliases destroy
      x-summary-source: derived
components:
  schemas:
    PatchedDomainAlias:
      type: object
      description: Base DomainAlias serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The alias name
          maxLength: 100
        target:
          type: integer
          description: The domain this alias points to
        enabled:
          type: boolean
          description: Check to activate this alias
    DomainAlias:
      type: object
      description: Base DomainAlias serializer.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The alias name
          maxLength: 100
        target:
          type: integer
          description: The domain this alias points to
        enabled:
          type: boolean
          description: Check to activate this alias
      required:
      - name
      - pk
      - target
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"