agentboxd-com Domains API

Your own domains for sending and receiving.

Operations 9

POST /v1/domains Add a custom domain #
GET /v1/domains List custom domains #
GET /v1/domains/{id} Get a custom domain and its DNS records #
PATCH /v1/domains/{id} Update a custom domain #
DELETE /v1/domains/{id} Delete a custom domain #
POST /v1/domains/{id}/dkim/activate Activate the new DKIM key #
POST /v1/domains/{id}/dkim/rotate Start a DKIM key rotation #
POST /v1/domains/{id}/verify Check a domain’s DNS records now #
GET /v1/domains/{id}/zone-file Get a domain’s DNS records as a zone file #

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/agentboxd-com:agentboxd-com-domains-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

agentboxd-com-domains-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Agentboxd Com Domains API
  version: '1'
  contact:
    name: Agentboxd
    url: https://agentboxd.com
    email: hello@agentboxd.com
  description: 'Operations tagged Domains across 2 of this provider''s published API definitions: agentboxd-com-openapi.json, agentboxd-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.agentboxd.com
security:
- apiKey: []
tags:
- name: Domains
  description: Your own domains for sending and receiving.
paths:
  /v1/domains:
    post:
      operationId: postDomains
      tags:
      - Domains
      summary: Add a custom domain
      description: '`{ domain, receiving? }` → 201 with `status: "pending"` and the DNS `records` to publish. How many depends on the plan (Free 1, Builder 10, Team 50; `403 plan_limit_domains` past it). See Custom domains.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  minLength: 1
                  maxLength: 253
                receiving:
                  type: boolean
              required:
              - domain
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    get:
      operationId: getDomains
      tags:
      - Domains
      summary: List custom domains
      description: 'List your domains.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
  /v1/domains/{id}:
    get:
      operationId: getDomainsById
      tags:
      - Domains
      summary: Get a custom domain and its DNS records
      description: 'One domain with its `records` and each record’s last check result. `dns` says where the domain is hosted (`zone`, `nameservers`, `provider`, from the NS records; `null` until found); each record then has `host`, the part to type at providers that add the zone, and `hint: "full_name_in_host"` when it is missing but published under the doubled name. See Custom domains.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: patchDomainsById
      tags:
      - Domains
      summary: Update a custom domain
      description: '`{ receiving }` turns receiving on or off.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                receiving:
                  type: boolean
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteDomainsById
      tags:
      - Domains
      summary: Delete a custom domain
      description: '`409 domain_in_use` while inboxes use the domain. `?force=true` deletes those inboxes too, the same way as deleting each one.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      - name: force
        in: query
        required: false
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
  /v1/domains/{id}/dkim/activate:
    post:
      operationId: postDomainsByIdDkimActivate
      tags:
      - Domains
      summary: Activate the new DKIM key
      description: 'Checks DNS now and switches signing to the new key; `409 dkim_record_not_found` until the record is published.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
  /v1/domains/{id}/dkim/rotate:
    post:
      operationId: postDomainsByIdDkimRotate
      tags:
      - Domains
      summary: Start a DKIM key rotation
      description: 'Starts a DKIM key rotation: a new key on the other selector (`cm1` ⇄ `cm2`), listed in `records` as `dkim_next`. Signing switches as soon as its record is seen. See Rotating the DKIM key.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
  /v1/domains/{id}/verify:
    post:
      operationId: postDomainsByIdVerify
      tags:
      - Domains
      summary: Check a domain’s DNS records now
      description: 'Checks the DNS records now and returns the domain. At most once every 10 seconds per domain.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
  /v1/domains/{id}/zone-file:
    get:
      operationId: getDomainsByIdZoneFile
      tags:
      - Domains
      summary: Get a domain’s DNS records as a zone file
      description: 'The records to publish as a BIND zone file, `{ filename, content }`, for DNS providers that import one. See Custom domains.


        Permission: `domains:manage`.'
      x-permission: domains:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.agentboxd.com
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: Stable, machine-readable error code.
            message:
              type: string
              description: What happened and how to fix it, in plain words.
            details:
              description: 'The specifics: which recipient, which limit, until when.'
            docs_url:
              type: string
              format: uri
              description: 'For a refused send: its entry on "Why was my send refused?" (https://agentboxd.com/docs/send-refusals).'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key (`mr_…`), scoped to the workspace or one inbox, with a set of permissions.
externalDocs:
  description: API reference
  url: https://agentboxd.com/docs/api
x-refined-from:
- agentboxd-com-openapi.json
- agentboxd-com-openapi.json