# Backup & Disaster Recovery

The Backup and Disaster Recovery API allows you to manage backup policies, snapshots, and disaster recovery operations in Firefly.

## Policies

### List Policies

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Create Policy

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Search Policies

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/search" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Get Policy

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Update Policy

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}" method="put" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Delete Policy

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}" method="delete" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Toggle Policy Status

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}/status" method="patch" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Trigger On-Demand Backup

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}/trigger" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Assign Resources to Policy

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/{policy\_id}/resources" method="patch" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Preview Affected Resources

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/preview" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### List Preview Resources

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/preview/{preview\_id}" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Search Preview Resources

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/policies/preview/{preview\_id}/search" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

## Snapshots

### List Snapshots

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Search Snapshots

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/search" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Get Snapshot

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Delete Snapshot

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}" method="delete" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Get Snapshot Resources

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/resources" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Search Snapshot Resources

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/resources/search" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Get Restore Instructions

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/restore-instructions" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Get Restored Module

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/module" method="get" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Create Restored Module

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/module" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

### Delete Restored Module

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/snapshots/{snapshot\_id}/module" method="delete" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}

## Resources

### Get Policies by FRNs

{% openapi src="<https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media>" path="/backup-and-dr/resources/policies" method="post" %}
[backup-and-dr.yaml](https://292727710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkD89Ravlokn4JL0Be27O%2Fuploads%2Fgit-blob-4d136e6c823c0f089ab0319dd15a488b8846ce2e%2Fbackup-and-dr.yaml?alt=media)
{% endopenapi %}