Migrations

OverviewCopy Anchor Link

Migration endpoints expose active and historical member migration state, estimate eligible pull counts, and control member migration runs. The all-server status endpoint covers servers owned by the API key's account; server-scoped endpoints also work on servers shared with that account through the pull_members sub-user permission.

Member pulls have no RestoreCord-imposed cooldown on any plan, including Free. Queued migrations wait for preceding work, without an additional cooldown. Discord rate limits, scheduled starts, and configured member or batch delays still apply.

For a step-by-step walkthrough, see Automate Pulls with the API. For what each option does in practice, see Pull Settings.

Migration StatusCopy Anchor Link

Return active migrations by default, or historical migrations with pagination when history=true. Migrations that finished within the last 10 minutes are still returned as active so their final result stays visible.

Returns active migration rows or paginated history for servers owned by the API key's account.

GET /api/v3/servers/status

Auth: API key with READ_SERVERS.

{
  "success": true,
  "migrations": [
    {
      "id": 77,
      "serverId": "42",
      "guildId": "111111111111111111",
      "sourceServerId": "42",
      "sourceGuildId": "111111111111111111",
      "targetGuildId": "222222222222222222",
      "serverName": "Community",
      "targetServerName": "New Community",
      "status": "PULLING",
      "success": 120,
      "attempted": 140,
      "total": 500,
      "failed": 2,
      "invalid": 18,
      "createdAt": "2026-06-07T10:30:00.000Z"
    }
  ],
  "total": 1
}

Server Migration StatusCopy Anchor Link

Return the latest migration row for one internal RestoreCord server id. The detailed status route includes an isActive flag and nested progress/count objects. Both routes require the server owner to be on Business or Enterprise; otherwise they return 403. When the server has no migrations, they return 404.

Get latest server migrationCopy Anchor Link

Returns the most recent migration for one server.

GET /api/v3/servers/{serverId}/migrations

Get detailed migration statusCopy Anchor Link

Returns progress and active-state details for the latest migration.

GET /api/v3/servers/{serverId}/migrations/status

{
  "success": true,
  "migration": {
    "id": 77,
    "guildId": "111111111111111111",
    "migrationGuildId": "222222222222222222",
    "status": "PULLING",
    "isActive": true,
    "progress": {
      "total": 500,
      "attempted": 140,
      "percentage": 28
    },
    "counts": {
      "success": 120,
      "banned": 0,
      "maxGuilds": 0,
      "invalid": 18,
      "failed": 2,
      "blacklisted": 0,
      "inServer": 0
    },
    "timestamps": {
      "created": "2026-06-07T10:30:00.000Z",
      "updated": "2026-06-07T10:40:00.000Z"
    }
  }
}

Estimate MigrationCopy Anchor Link

Estimate how many authorized members are eligible before starting a migration. Query filters mirror the start route's country and quality filters, with the same plan gates. count is the eligible member count after filters and firewall blocks; total is every member who still authorizes the bot. Members already in the target guild are included in count. Rate limit: 15 requests per minute.

Returns eligible and total member counts for one server.

GET /api/v3/servers/{serverId}/migrations/estimate

{
  "success": true,
  "count": 500,
  "total": 620
}

Start MigrationCopy Anchor Link

Start or queue a member migration from one RestoreCord source server into a target Discord guild. The route validates the target guild, bot token, selected roles, member eligibility, queue state, and Discord invite status before starting, including that the bot can assign each selected role in the target guild. Rate limit: 5 starts per minute.

• Queueing: the migration is queued (migration.queued: true) when another migration for the same server is pending or pulling.
• Plan gates: countryCode needs a Business or Enterprise owner. maxChurnRate and minDaysSinceLeft need Business or Enterprise; minRetentionDays and maxActivityInterval need Enterprise. nickname, startTime, and leaveServer need Premium or higher; memberPerGroup and delayBetweenGroups need Enterprise. Options your plan doesn't include have no effect.
• Delays: when delayMin equals delayMax, the fixed delay is used on every plan. A range needs a Premium or higher owner. Without a delay, RestoreCord uses a safe default within Discord's rate limits. With a range, each member waits between the minimum and maximum.

Starts or queues a member migration.

POST /api/v3/servers/{serverId}/migrations

{
  "targetGuildId": "222222222222222222",
  "selectedRoles": ["333333333333333333"],
  "customPullCount": 250,
  "delayMin": 700,
  "delayMax": 1200,
  "leaveServer": false,
  "includeUnknownMembers": true
}

Returns 201:

{
  "success": true,
  "message": "Started Pull Process, this will take around 4 minutes",
  "migration": {
    "totalMembers": 250,
    "estimatedTime": "4 minutes",
    "queued": false,
    "targetMembersUnavailable": false
  }
}

When queued, message is "Migration queued. It will start after the current migration completes." When targetMembersUnavailable is true, the bot can't read the target guild's members (Server Members Intent is off), so members already in the guild can't be skipped up front, and the message ends with a note about enabling Server Members Intent.

Stop or Pause MigrationCopy Anchor Link

Stop active migrations for a server, or pause them with action=pause. Pause applies to pending, waiting and pulling migrations; stop also applies to paused ones. When migrationId is omitted, the update applies to all matching migrations for that server. A stopped migration can't be resumed.

Stops active server migrations or pauses them with action=pause.

DELETE /api/v3/servers/{serverId}/migrations

{
  "success": true,
  "message": "Migration stopped successfully."
}

{
  "success": true,
  "message": "Migration paused successfully."
}

Resume MigrationCopy Anchor Link

Resume one paused migration. Returns 409 with "Only paused migrations can be resumed." or "Stopped migrations cannot be resumed." otherwise. Rate limit: 5 requests per minute.

Resumes one paused migration.

PATCH /api/v3/servers/{serverId}/migrations

{
  "success": true,
  "message": "Migration resumed successfully."
}

Response FieldsCopy Anchor Link

Status and ErrorsCopy Anchor Link

Every start error message, with its cause and fix, is listed in Results and Troubleshooting.