MepMail Domains API

Sending domains and their DNS records.

GitHub OpenAPI

Operations 6

POST /domains Add a domain #
GET /domains List domains #
GET /domains/{id} Retrieve a domain #
PATCH /domains/{id} Update a domain #
DELETE /domains/{id} Delete a domain #
POST /domains/{id}/verify Verify a domain #

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/mepmail-dev:mepmail-dev-domains-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

mepmail-dev-domains-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mepmail Dev Domains API
  version: 1.0.0
  description: 'Operations tagged Domains across 2 of this provider''s published API definitions: docs.json, mepmail-dev-docs-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mepmail.dev
  description: MepMail Cloud
- url: '{baseUrl}'
  description: Self-hosted instance
  variables:
    baseUrl:
      default: http://localhost:3001
security:
- apiKey: []
tags:
- name: Domains
  description: Sending domains and their DNS records.
paths:
  /domains:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDomainRequest'
            example:
              name: mail.yourdomain.com
      responses:
        '200':
          description: Domain created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDomainResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                name: Order updates
                status: status
                created_at: '2026-10-19T12:00:00.000Z'
                region: us-east-1
                open_tracking: false
                click_tracking: false
                tracking_subdomain: tracking subdomain
                capabilities:
                  sending: sending
                  receiving: receiving
                records:
                - record: record
                  name: Order updates
                  type: type
                  ttl: ttl
                  status: status
                  value: '@example.com'
                  priority: 1
                  live: found
                  detail: detail
                  inherited_from: inherited from
                  policy: none
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Plan domain limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Domain already added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many domains created recently, or the rate limit was exceeded (see Retry-After)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
      operationId: createDomain
      summary: Add a domain
      tags:
      - Domains
      description: Adds a sending domain and returns the DNS records to publish.
    get:
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          description: Page size, 1-100 (default 20)
        required: false
        description: Page size, 1-100 (default 20)
        name: limit
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        required: false
        description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        name: after
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        required: false
        description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        name: before
        in: query
      responses:
        '200':
          description: Domains
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainsResponse'
              example:
                object: list
                data:
                - id: 4ef9a417-02e9-4d39-ad75-9611e0fcc33c
                  name: Order updates
                  status: status
                  created_at: '2026-10-19T12:00:00.000Z'
                  region: us-east-1
                  open_tracking: false
                  click_tracking: false
                  tracking_subdomain: tracking subdomain
                  capabilities:
                    sending: sending
                    receiving: receiving
                has_more: false
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: listDomains
      summary: List domains
      tags:
      - Domains
      description: Lists the team's domains.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /domains/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Domain with its DNS records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                name: Order updates
                status: status
                created_at: '2026-10-19T12:00:00.000Z'
                region: us-east-1
                open_tracking: false
                click_tracking: false
                tracking_subdomain: tracking subdomain
                capabilities:
                  sending: sending
                  receiving: receiving
                object: domain
                records:
                - record: record
                  name: Order updates
                  type: type
                  ttl: ttl
                  status: status
                  value: '@example.com'
                  priority: 1
                  live: found
                  detail: detail
                  inherited_from: inherited from
                  policy: none
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getDomain
      summary: Retrieve a domain
      tags:
      - Domains
      description: Returns one domain with its DNS records and their status.
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainRequest'
            example:
              open_tracking: true
              click_tracking: true
              tracking_subdomain: links
      responses:
        '200':
          description: Domain updated; full object with records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                name: Order updates
                status: status
                created_at: '2026-10-19T12:00:00.000Z'
                region: us-east-1
                open_tracking: false
                click_tracking: false
                tracking_subdomain: tracking subdomain
                capabilities:
                  sending: sending
                  receiving: receiving
                object: domain
                records:
                - record: record
                  name: Order updates
                  type: type
                  ttl: ttl
                  status: status
                  value: '@example.com'
                  priority: 1
                  live: found
                  detail: detail
                  inherited_from: inherited from
                  policy: none
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: updateDomain
      summary: Update a domain
      tags:
      - Domains
      description: Changes a domain's click and open tracking or TLS policy.
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Domain deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveDomainResponse'
              example:
                object: domain
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                deleted: true
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteDomain
      summary: Delete a domain
      tags:
      - Domains
      description: Removes a sending domain from the team.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /domains/{id}/verify:
    post:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: 'Verification result: the domain with per-record status'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomainResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                name: Order updates
                status: status
                created_at: '2026-10-19T12:00:00.000Z'
                region: us-east-1
                open_tracking: false
                click_tracking: false
                tracking_subdomain: tracking subdomain
                capabilities:
                  sending: sending
                  receiving: receiving
                object: domain
                records:
                - record: record
                  name: Order updates
                  type: type
                  ttl: ttl
                  status: status
                  value: '@example.com'
                  priority: 1
                  live: found
                  detail: detail
                  inherited_from: inherited from
                  policy: none
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: verifyDomain
      summary: Verify a domain
      tags:
      - Domains
      description: Checks the domain's DNS records now and returns each record's status.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
components:
  schemas:
    RemoveDomainResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - domain
        id:
          type: string
          format: uuid
        deleted:
          type: boolean
          enum:
          - true
      required:
      - object
      - id
      - deleted
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
        name:
          type: string
        message:
          type: string
      required:
      - statusCode
      - name
      - message
    GetDomainResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
        created_at:
          type: string
        region:
          type: string
        open_tracking:
          type: boolean
        click_tracking:
          type: boolean
        tracking_subdomain:
          type:
          - string
          - 'null'
        capabilities:
          type: object
          properties:
            sending:
              type: string
            receiving:
              type: string
          required:
          - sending
          - receiving
        object:
          type: string
          enum:
          - domain
        records:
          type: array
          items:
            type: object
            properties:
              record:
                type: string
                description: 'Which record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, or Tracking (the branded tracking CNAME, present once a tracking subdomain is set). Only the DKIM and SPF rows gate sending.'
              name:
                type: string
              type:
                type: string
              ttl:
                type: string
              status:
                type: string
                description: 'not_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider''s verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain''s (see inherited_from) — and not_started when none does. Tracking reads verified once its CNAME resolves.'
              value:
                type: string
              priority:
                type: number
              live:
                type: string
                enum:
                - found
                - missing
                - mismatch
                - unknown
                description: 'What public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response).'
              detail:
                type: string
                description: 'One sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add.'
              inherited_from:
                type: string
                description: 'DMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback).'
              policy:
                type: string
                enum:
                - none
                - quarantine
                - reject
                description: 'DMARC only, alongside inherited_from: the inherited policy''s p= value.'
            required:
            - record
            - name
            - type
            - ttl
            - status
            - value
      required:
      - id
      - name
      - status
      - created_at
      - region
      - open_tracking
      - click_tracking
      - tracking_subdomain
      - capabilities
      - object
      - records
    ListDomainsResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              status:
                type: string
              created_at:
                type: string
              region:
                type: string
              open_tracking:
                type: boolean
              click_tracking:
                type: boolean
              tracking_subdomain:
                type:
                - string
                - 'null'
              capabilities:
                type: object
                properties:
                  sending:
                    type: string
                  receiving:
                    type: string
                required:
                - sending
                - receiving
            required:
            - id
            - name
            - status
            - created_at
            - region
            - open_tracking
            - click_tracking
            - tracking_subdomain
            - capabilities
        has_more:
          type: boolean
      required:
      - object
      - data
      - has_more
    CreateDomainResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
        created_at:
          type: string
        region:
          type: string
        open_tracking:
          type: boolean
        click_tracking:
          type: boolean
        tracking_subdomain:
          type:
          - string
          - 'null'
        capabilities:
          type: object
          properties:
            sending:
              type: string
            receiving:
              type: string
          required:
          - sending
          - receiving
        records:
          type: array
          items:
            type: object
            properties:
              record:
                type: string
                description: 'Which record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, or Tracking (the branded tracking CNAME, present once a tracking subdomain is set). Only the DKIM and SPF rows gate sending.'
              name:
                type: string
              type:
                type: string
              ttl:
                type: string
              status:
                type: string
                description: 'not_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider''s verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain''s (see inherited_from) — and not_started when none does. Tracking reads verified once its CNAME resolves.'
              value:
                type: string
              priority:
                type: number
              live:
                type: string
                enum:
                - found
                - missing
                - mismatch
                - unknown
                description: 'What public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response).'
              detail:
                type: string
                description: 'One sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add.'
              inherited_from:
                type: string
                description: 'DMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback).'
              policy:
                type: string
                enum:
                - none
                - quarantine
                - reject
                description: 'DMARC only, alongside inherited_from: the inherited policy''s p= value.'
            required:
            - record
            - name
            - type
            - ttl
            - status
            - value
      required:
      - id
      - name
      - status
      - created_at
      - region
      - open_tracking
      - click_tracking
      - tracking_subdomain
      - capabilities
      - records
    UpdateDomainRequest:
      type: object
      properties:
        click_tracking:
          type: boolean
          description: Rewrite links to redirect through the tracking subdomain and record email.clicked events. Off by default.
        open_tracking:
          type: boolean
          description: Inject a tracking pixel served from the tracking subdomain and record email.opened events. Off by default.
        tracking_subdomain:
          type:
          - string
          - 'null'
          description: DNS label of the branded tracking host, e.g. "links" for links.<domain>. Setting it adds a Tracking CNAME to records[]; links are tracked through it once that CNAME resolves. Required on MepMail Cloud to turn tracking on. Empty string or null clears it.
        tls: {}
        capabilities: {}
    CreateDomainRequest:
      type: object
      properties:
        name:
          type: string
        region:
          type: string
          enum:
          - us-east-1
          description: 'SES region of the identity, one of the regions this deployment serves (the values listed here; the first is the default). Any other region is rejected with 422. A domain has one region: to move it, delete and re-add it.'
        custom_return_path:
          type: string
          default: send
        open_tracking:
          type: boolean
          description: Inject a tracking pixel served from the tracking subdomain and record email.opened events. Off by default.
        click_tracking:
          type: boolean
          description: Rewrite links to redirect through the tracking subdomain and record email.clicked events. Off by default.
        tracking_subdomain:
          type: string
          description: DNS label of the branded tracking host, e.g. "links" for links.<domain>. Setting it adds a Tracking CNAME to records[]; links are tracked through it once that CNAME resolves. Required on MepMail Cloud to turn tracking on.
      required:
      - name
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key from the dashboard (ms_…), sent as Authorization: Bearer. A sending-only key reaches the /emails routes only.'
x-refined-from:
- docs.json
- mepmail-dev-docs-openapi.json
x-provenance:
  method: harvested
  publisher: MepMail
  source: https://docs.mepmail.dev/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)