Modoboa Resources API

The resources API from Modoboa — 1 operation(s) for resources.

Operations 3

GET /api/v2/resources/{id}/ Resources retrieve #
PUT /api/v2/resources/{id}/ Resources update #
PATCH /api/v2/resources/{id}/ Resources partial update #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-resources-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

modoboa-resources-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Modoboa Resources 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: Resources
paths:
  /api/v2/resources/{id}/:
    get:
      operationId: resources_retrieve
      description: Resources viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Resources
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resources'
          description: ''
      summary: Resources retrieve
      x-summary-source: derived
    put:
      operationId: resources_update
      description: Resources viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Resources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resources'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Resources'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Resources'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resources'
          description: ''
      summary: Resources update
      x-summary-source: derived
    patch:
      operationId: resources_partial_update
      description: Resources viewset.
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - Resources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedResources'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedResources'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedResources'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resources'
          description: ''
      summary: Resources partial update
      x-summary-source: derived
components:
  schemas:
    PatchedResources:
      type: object
      description: Resources serializer.
      properties:
        domains:
          type: integer
          minimum: -1
        domain_aliases:
          type: integer
          minimum: -1
        mailboxes:
          type: integer
          minimum: -1
        mailbox_aliases:
          type: integer
          minimum: -1
        domain_admins:
          type: integer
          minimum: -1
        quota:
          type: integer
          minimum: 0
    Resources:
      type: object
      description: Resources serializer.
      properties:
        domains:
          type: integer
          minimum: -1
        domain_aliases:
          type: integer
          minimum: -1
        mailboxes:
          type: integer
          minimum: -1
        mailbox_aliases:
          type: integer
          minimum: -1
        domain_admins:
          type: integer
          minimum: -1
        quota:
          type: integer
          minimum: 0
      required:
      - domain_admins
      - domain_aliases
      - domains
      - mailbox_aliases
      - mailboxes
      - quota
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"