Snapshots

OverviewCopy Anchor Link

Snapshots are Discord server backups. Creation requires an API key with CREATE_BACKUPS and restore/delete operations generally require RESTORE_BACKUPS. Besides snapshots owned by the API key's account, the key can reach snapshots of servers shared with that account through the create_snapshot or manage_snapshots sub-user permissions, where the route allows it.

| DELETE /api/v3/snapshots/pending-roles/{guildId} and POST /api/v3/snapshots/pending-roles/{guildId}/restore | Manage pending role restoration | RESTORE_BACKUPS |

Create SnapshotCopy Anchor Link

Start a snapshot job for one server. The server owner's per-server snapshot limit and plan-based attachment and message limits apply.

Starts an asynchronous snapshot job.

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

{
  "snapshotName": "Before launch",
  "snapshotDescription": "Pre-launch backup",
  "attachmentMode": 1,
  "enableEmojiBackup": true,
  "messageCount": 250,
  "excludedChannels": ["333333333333333333"]
}

{
  "success": true,
  "message": "Snapshot creation started successfully.",
  "snapshotId": "snap_abc123"
}

List SnapshotsCopy Anchor Link

List snapshots owned by the API key's account plus snapshots from shared servers where that account has snapshot permissions.

Returns accessible snapshot metadata.

GET /api/v3/snapshots

{
  "success": true,
  "snapshots": [
    {
      "id": 5,
      "snapshotId": "snap_abc123",
      "snapshotName": "Before launch",
      "snapshotDescription": "Pre-launch backup",
      "sourceGuildId": "123456789012345678",
      "totalChannels": 32,
      "totalRoles": 18,
      "totalMembers": 1200,
      "totalMessages": 5000,
      "totalAttachments": 100,
      "totalEmojis": 25,
      "pinned": false,
      "version": 1,
      "createdAt": "2026-06-07T10:30:00.000Z",
      "updatedAt": "2026-06-07T10:30:00.000Z",
      "isOwner": true,
      "canManage": true
    }
  ],
  "total": 1,
  "subscription": {
    "role": "business",
    "canCreateSnapshots": true
  }
}

Snapshot DetailsCopy Anchor Link

Get snapshotCopy Anchor Link

Returns one snapshot's metadata.

GET /api/v3/snapshots/{snapshotId}

Update snapshotCopy Anchor Link

Update snapshot name, description, or pinned state.

PATCH /api/v3/snapshots/{snapshotId}

Delete snapshotCopy Anchor Link

Delete a snapshot and its stored data.

DELETE /api/v3/snapshots/{snapshotId}

Restore SnapshotCopy Anchor Link

Start a restore job into a target Discord server. The caller can provide either an owned bot token or the botId of a bot the account can use.

Starts an asynchronous snapshot restore job.

POST /api/v3/snapshots/{snapshotId}/restore

{
  "guildId": "222222222222222222",
  "botId": "555555555555555555",
  "restoreMessageCount": 250,
  "clearServer": false
}

{
  "success": true,
  "message": "Snapshot restoration started successfully.",
  "data": {
    "success": true,
    "jobId": "restore_abc123"
  }
}

Restore Error MappingCopy Anchor Link

Migrate SnapshotCopy Anchor Link

Start a migration for an older v0 snapshot. The migrated snapshot remains attributed to the snapshot/server owner.

Starts a v0-to-current snapshot migration job.

POST /api/v3/snapshots/{snapshotId}/migrate

{
  "success": true,
  "message": "Snapshot migration started successfully."
}

Pending Role RestoreCopy Anchor Link

Pending role restore endpoints manage role-restoration data saved during snapshot restore flows.

Delete pending role restoreCopy Anchor Link

Cancel and delete pending role restoration data for a target guild/snapshot.

DELETE /api/v3/snapshots/pending-roles/{guildId}

Start pending role restoreCopy Anchor Link

Begin restoring roles from previously saved pending data.

POST /api/v3/snapshots/pending-roles/{guildId}/restore

• The bot in pending data must still be in the target server.
• Only one role restore should run at a time for a server.
• The endpoints require snapshot restore/manage access.

Status and ErrorsCopy Anchor Link