dbmigratepro-com Replicas API

The Replicas API from dbmigratepro-com — 10 operation(s) for replicas.

Operations 14

POST /api/replicas Post replicas #
GET /api/replicas Get replicas #
POST /api/replicas/preflight Post replicas preflight #
POST /api/replicas/probe Post replicas probe #
GET /api/replicas/{replica} Get replicas replica #
PUT /api/replicas/{replica} Put replicas replica #
PATCH /api/replicas/{replica} Patch replicas replica #
DELETE /api/replicas/{replica} Delete replicas replica #
POST /api/replicas/{replica}/clear-urls Post replicas replica clear urls #
POST /api/replicas/{replica}/pause Post replicas replica pause #
POST /api/replicas/{replica}/promote Post replicas replica promote #
POST /api/replicas/{replica}/resume Post replicas replica resume #
GET /api/replicas/{replica}/runs Get replicas replica runs #
POST /api/replicas/{replica}/sync Post replicas replica sync #

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/dbmigratepro-com:dbmigratepro-com-replicas-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

dbmigratepro-com-replicas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DBMigratePro REST Replicas API
  version: 1.0.0
  summary: Migrate, convert, back up, and restore MySQL and PostgreSQL databases over HTTP.
  description: 'Everything the dashboard does, it does through this API — there is no privileged back

    channel — so a script or an AI agent can drive the whole product.


    **Authentication.** A personal API token from Settings → API Tokens, sent as

    `Authorization: Bearer `. Tokens are full-account: no endpoint currently checks a

    narrower ability. Requests are scoped to the token owner''s *acting team*, which

    `POST /api/teams/{team}/switch` changes — so the same token can see different resources

    over time.


    **Connection URLs are write-only.** Database URLs and storage secrets are encrypted at

    rest and never appear in a response. There is no read-back endpoint.


    **Rate limits, tiered by what an endpoint costs us** (per authenticated user, keyed on

    user id):


    - AI endpoints: 10/minute and 200/day — each call spends money on a model.

    - Probe endpoints (anything that dials a database you supply): 20/minute.

    - Reads: 300/minute. Writes: 60/minute. Token minting: 10/hour.

    - Restores are deliberately left out of the probe and write tiers — they inherit only the

    generous read limit above, because a restore has to work in the middle of an outage.

    Unauthenticated public reads are IP-limited instead.


    Each operation below carries an `x-rate-limit` field naming its tier.


    **Rules for agents.** Two are not negotiable. An agent must never complete a payment on

    a user''s behalf: when a run needs one, the response carries a `checkout_url` to hand

    back to the user, and the run starts by itself once they authorise it. And a destructive

    call — delete, reset — must be confirmed by the user first. A failed migration is never

    charged, and restores are never charged at all, so both are safe to explain plainly.


    This document is generated from the live route table. The narrative guides are at

    https://dbmigratepro.com/docs, and there is an MCP server for clients that speak it —

    see https://dbmigratepro.com/docs/mcp-setup.'
  contact:
    name: DBMigratePro support
    url: https://dbmigratepro.com/contact
servers:
- url: https://dbmigratepro.com
security:
- bearerAuth: []
tags:
- name: Replicas
paths:
  /api/replicas:
    post:
      operationId: postReplicas
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 60/minute
      x-requires-subscription: true
      description: Requires an active paid plan (Pro or Business). Free-tier callers receive 403; reading the resource is not gated, only creating or running one is.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 255
                  nullable: true
                source_db_url:
                  type: string
                  maxLength: 2000
                source_db_type:
                  type: string
                  enum:
                  - mysql
                  - postgresql
                  nullable: true
                target_db_url:
                  type: string
                  maxLength: 2000
                target_db_type:
                  type: string
                  enum:
                  - mysql
                  - postgresql
                  nullable: true
                frequency:
                  type: integer
                  minimum: 5
                  nullable: true
                cursor_column:
                  type: string
                  maxLength: 255
                  nullable: true
                full_resync_interval:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  nullable: true
                verify_hashes:
                  type: boolean
                  nullable: true
                notify:
                  type: boolean
                enabled:
                  type: boolean
              required:
              - source_db_url
              - target_db_url
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas
      x-summary-source: derived
    get:
      operationId: getReplicas
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Get replicas
      x-summary-source: derived
  /api/replicas/preflight:
    post:
      operationId: postReplicasPreflight
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 20/minute
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas preflight
      x-summary-source: derived
  /api/replicas/probe:
    post:
      operationId: postReplicasProbe
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 20/minute
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas probe
      x-summary-source: derived
  /api/replicas/{replica}:
    get:
      operationId: getReplicasReplica
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Get replicas replica
      x-summary-source: derived
    put:
      operationId: putReplicasReplica
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 255
                  nullable: true
                target_db_url:
                  type: string
                  maxLength: 2000
                target_db_type:
                  type: string
                  enum:
                  - mysql
                  - postgresql
                  nullable: true
                frequency:
                  type: integer
                  minimum: 5
                cursor_column:
                  type: string
                  maxLength: 255
                  nullable: true
                full_resync_interval:
                  type: integer
                  minimum: 1
                  maximum: 1000
                verify_hashes:
                  type: boolean
                notify:
                  type: boolean
                enabled:
                  type: boolean
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Put replicas replica
      x-summary-source: derived
    patch:
      operationId: patchReplicasReplica
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 255
                  nullable: true
                target_db_url:
                  type: string
                  maxLength: 2000
                target_db_type:
                  type: string
                  enum:
                  - mysql
                  - postgresql
                  nullable: true
                frequency:
                  type: integer
                  minimum: 5
                cursor_column:
                  type: string
                  maxLength: 255
                  nullable: true
                full_resync_interval:
                  type: integer
                  minimum: 1
                  maximum: 1000
                verify_hashes:
                  type: boolean
                notify:
                  type: boolean
                enabled:
                  type: boolean
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Patch replicas replica
      x-summary-source: derived
    delete:
      operationId: deleteReplicasReplica
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Delete replicas replica
      x-summary-source: derived
  /api/replicas/{replica}/clear-urls:
    post:
      operationId: postReplicasReplicaClearUrls
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas replica clear urls
      x-summary-source: derived
  /api/replicas/{replica}/pause:
    post:
      operationId: postReplicasReplicaPause
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas replica pause
      x-summary-source: derived
  /api/replicas/{replica}/promote:
    post:
      operationId: postReplicasReplicaPromote
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas replica promote
      x-summary-source: derived
  /api/replicas/{replica}/resume:
    post:
      operationId: postReplicasReplicaResume
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      x-requires-subscription: true
      description: Requires an active paid plan (Pro or Business). Free-tier callers receive 403; reading the resource is not gated, only creating or running one is.
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas replica resume
      x-summary-source: derived
  /api/replicas/{replica}/runs:
    get:
      operationId: getReplicasReplicaRuns
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 300/minute
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Get replicas replica runs
      x-summary-source: derived
  /api/replicas/{replica}/sync:
    post:
      operationId: postReplicasReplicaSync
      tags:
      - Replicas
      security:
      - bearerAuth: []
      x-rate-limit: 60/minute
      x-requires-subscription: true
      description: Requires an active paid plan (Pro or Business). Free-tier callers receive 403; reading the resource is not gated, only creating or running one is.
      parameters:
      - name: replica
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success.
        '201':
          description: Created, for the endpoints that create a resource.
        '401':
          description: Missing or invalid API token.
        '403':
          description: The resource belongs to another team, or the endpoint is admin-only.
        '404':
          description: No such resource.
        '422':
          description: Validation failed. The body carries `message` and `errors`.
        '429':
          description: Rate limit exceeded for this tier. Retry after the `Retry-After` header.
      summary: Post replicas replica sync
      x-summary-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'A personal API token from Settings → API Tokens, sent as `Authorization: Bearer <token>`.'
externalDocs:
  description: Documentation
  url: https://dbmigratepro.com/docs