{"templateId":"markdown","versions":[{"version":"v1.37","label":"v1.37 STS","link":"/products/custody/operations-and-maintenance/backup-and-restore","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.36","label":"v1.36 STS","link":"/products/custody/v1.36/operations-and-maintenance/backup-and-restore","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/operations-and-maintenance/backup-and-restore","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/operations-and-maintenance/backup-and-restore","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/operations-and-maintenance/backup-and-restore","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/operations-and-maintenance/backup-and-restore","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Back up, restore, and recover","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"back-up-restore-and-recover","__idx":0},"children":["Back up, restore, and recover"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Backups in ","Ripple Custody"," have two distinct scopes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Platform state backups"]}," protect operational state such as PostgreSQL data, configuration, request state, events, and recovery metadata."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vault and KMS backups"]}," protect the key material or key shares required to recover signing capability."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not treat one scope as a substitute for the other. Restore planning must account for both platform state and vault key material."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-to-back-up","__idx":1},"children":["What to back up"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Backup scope"},"children":["Backup scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it protects"},"children":["What it protects"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Where to go"},"children":["Where to go"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL database"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform source of truth, including state used by accounts, transactions, requests, and events."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/planning/database"},"children":["Database planning"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/planning/resilience"},"children":["Resilience planning"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Anti-rewind file and state review authority process"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State recovery and rollback protection."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/recover-anti-rewind-file"},"children":["Recover anti-rewind file"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/register-a-key"},"children":["Register a key"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HSM-backed vault key material"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HSM-protected master seed or wrapped seed material, depending on the KMS integration."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The relevant KMS integration guide under ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/overview"},"children":["Integrate a KMS"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MPC-backed vault key material"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer-held encrypted MPC backups and validation artifacts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/mpc/backups"},"children":["MPC backups"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cold vault operation payloads"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offline cold-vault operation exchange files and signing workflow material."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/vault-management/cold-vaults"},"children":["Cold vaults"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/vault-management/cold-vault-setup-api"},"children":["Cold vault API operations"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/vault-management/cold-vault-setup-ui"},"children":["Cold vault UI operations"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For vault-level key strategy context, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/vault-management#key-strategies-and-backup-implications"},"children":["Vaults"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"backup-procedures","__idx":2},"children":["Backup procedures"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this section to route operators to the correct backup procedure. The exact runbook depends on the deployment model and KMS."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"platform-state","__idx":3},"children":["Platform state"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Back up PostgreSQL and platform state according to your deployment architecture. For on-premises deployments, your operations team owns database backup, replication, retention, and restore testing. For Ripple-managed environments, coordinate with your Ripple account team."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Review:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/planning/database"},"children":["Database planning"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/planning/resilience"},"children":["Resilience planning"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/recover-anti-rewind-file"},"children":["Recover anti-rewind file"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hsm-backed-vaults","__idx":4},"children":["HSM-backed vaults"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For HSM-backed vaults, follow the backup procedure for the specific HSM platform and deployment model. HSM backup requirements vary by vendor and by whether the deployment uses physical HSMs, cloud HSMs, or wrapped key material."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start with the relevant KMS guide under ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/overview"},"children":["Integrate a KMS"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"mpc-backed-vaults","__idx":5},"children":["MPC-backed vaults"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For MPC-backed vaults, use the customer-held MPC backup workflow:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate the backup encryption and decryption keys."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Associate the backup encryption key with the vault."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Submit the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateBackup"]}," intent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check backup status."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Download the trusted entity backup payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Acknowledge receipt with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_AcknowledgeBackup"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify the downloaded backup."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full procedure, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/mpc/backups"},"children":["MPC backups"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"restore-procedures","__idx":6},"children":["Restore procedures"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"platform-state-restore","__idx":7},"children":["Platform state restore"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use your database restore runbook together with the anti-rewind file recovery process. For source material, see:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/recover-anti-rewind-file"},"children":["Recover anti-rewind file"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/register-a-key"},"children":["Register the state review authority key"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/planning/database"},"children":["Database planning"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hsm-backed-vault-restore","__idx":8},"children":["HSM-backed vault restore"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For HSM-backed vaults, use the restore process for the specific KMS and vendor deployment. Requirements vary by HSM provider, cluster model, wrapping-key approach, and whether the HSM backup is managed by the cloud provider or by the customer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start with the relevant guide under ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/overview"},"children":["Integrate a KMS"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"mpc-backed-vault-recovery-and-exit","__idx":9},"children":["MPC-backed vault recovery and exit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For MPC-backed vaults, use the MPC backup material and the exit strategy process described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/mpc/backups#exit-strategy"},"children":["MPC backups"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validation","__idx":10},"children":["Validation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Validate backups before you rely on them in production."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Backup type"},"children":["Backup type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Validation activity"},"children":["Validation activity"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PostgreSQL and platform state"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run restore drills in a non-production environment and confirm that requests, events, accounts, and configuration state are usable."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Anti-rewind file recovery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exercise the anti-rewind file recovery process and verify the state review authority key path."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HSM-backed vault material"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Test the vendor-specific HSM restore procedure according to your KMS runbook."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MPC-backed vault material"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run the backup verification script against the downloaded backup JSON."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For MPC-specific validation details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/deployment/integrate-kms/mpc/backups#verify-the-backup"},"children":["Verify the backup"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-recovery-procedures","__idx":11},"children":["Related recovery procedures"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Need"},"children":["Need"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Procedure"},"children":["Procedure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register or rotate the state review authority key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/register-a-key"},"children":["Register the state review authority public key"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recover the anti-rewind file"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/backup-and-restore/recover-anti-rewind-file"},"children":["Recover your anti-rewind file"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recover cold vault operations after workstation loss"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/identity-and-access/vault-management/cold-vault-recovery"},"children":["Recover a cold vault"]}]}]}]}]}]}]},"headings":[{"value":"Back up, restore, and recover","id":"back-up-restore-and-recover","depth":1},{"value":"What to back up","id":"what-to-back-up","depth":2},{"value":"Backup procedures","id":"backup-procedures","depth":2},{"value":"Platform state","id":"platform-state","depth":3},{"value":"HSM-backed vaults","id":"hsm-backed-vaults","depth":3},{"value":"MPC-backed vaults","id":"mpc-backed-vaults","depth":3},{"value":"Restore procedures","id":"restore-procedures","depth":2},{"value":"Platform state restore","id":"platform-state-restore","depth":3},{"value":"HSM-backed vault restore","id":"hsm-backed-vault-restore","depth":3},{"value":"MPC-backed vault recovery and exit","id":"mpc-backed-vault-recovery-and-exit","depth":3},{"value":"Validation","id":"validation","depth":2},{"value":"Related recovery procedures","id":"related-recovery-procedures","depth":2}],"frontmatter":{"seo":{"title":"Back up, restore, and recover"}},"lastModified":"2026-07-10T17:34:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/operations-and-maintenance/backup-and-restore","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}