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-relaydomains-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 Relaydomains 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: relaydomains
paths:
  /api/v2/relaydomains/:
    get:
      operationId: relaydomains_list
      description: RelayDomain viewset.
      tags:
      - relaydomains
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelayDomain'
          description: ''
      summary: Relaydomains list
      x-summary-source: derived
    post:
      operationId: relaydomains_create
      description: RelayDomain viewset.
      tags:
      - relaydomains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelayDomain'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RelayDomain'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RelayDomain'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayDomain'
          description: ''
      summary: Relaydomains create
      x-summary-source: derived
  /api/v2/relaydomains/{id}/:
    get:
      operationId: relaydomains_retrieve
      description: RelayDomain viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - relaydomains
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayDomain'
          description: ''
      summary: Relaydomains retrieve
      x-summary-source: derived
    put:
      operationId: relaydomains_update
      description: RelayDomain viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - relaydomains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelayDomain'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RelayDomain'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RelayDomain'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayDomain'
          description: ''
      summary: Relaydomains update
      x-summary-source: derived
    patch:
      operationId: relaydomains_partial_update
      description: RelayDomain viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - relaydomains
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRelayDomain'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedRelayDomain'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedRelayDomain'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelayDomain'
          description: ''
      summary: Relaydomains partial update
      x-summary-source: derived
    delete:
      operationId: relaydomains_destroy
      description: RelayDomain viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - relaydomains
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Relaydomains destroy
      x-summary-source: derived
components:
  schemas:
    PatchedRelayDomain:
      type: object
      description: RelayDomain serializer class.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The domain name
          maxLength: 253
        enabled:
          type: boolean
          description: Check to activate this domain
        transport:
          $ref: '#/components/schemas/Transport'
        enable_dkim:
          type: boolean
          title: Enable DKIM signing
          description: If you activate this feature, a DKIM key will be generated for this domain.
        dkim_key_selector:
          type: string
          maxLength: 30
        dkim_public_key:
          type: string
          readOnly: true
    RelayDomain:
      type: object
      description: RelayDomain serializer class.
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          description: The domain name
          maxLength: 253
        enabled:
          type: boolean
          description: Check to activate this domain
        transport:
          $ref: '#/components/schemas/Transport'
        enable_dkim:
          type: boolean
          title: Enable DKIM signing
          description: If you activate this feature, a DKIM key will be generated for this domain.
        dkim_key_selector:
          type: string
          maxLength: 30
        dkim_public_key:
          type: string
          readOnly: true
      required:
      - dkim_public_key
      - name
      - pk
      - transport
    Transport:
      type: object
      description: Serializer for Transport model.
      properties:
        service:
          type: string
          maxLength: 30
        settings:
          type: object
          additionalProperties: {}
      required:
      - service
      - settings
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"