Skip to content

backups.md

Latest commit

 

History

History
172 lines (111 loc) · 5.89 KB

backups.md

File metadata and controls

172 lines (111 loc) · 5.89 KB

Backups Service

GET https://cloud.appwrite.io/v1/backups/archives

** List all archives for a project. **

Parameters

Field Name Type Description Default
queries array Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. [] 
POST https://cloud.appwrite.io/v1/backups/archives

** Create a new archive asynchronously for a project. **

Parameters

Field Name Type Description Default
services array Array of services to backup
resourceId string Resource ID. When set, only this single resource will be backed up. 
GET https://cloud.appwrite.io/v1/backups/archives/{archiveId}

** Get a backup archive using it's ID. **

Parameters

Field Name Type Description Default
archiveId string Required Archive ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. 
DELETE https://cloud.appwrite.io/v1/backups/archives/{archiveId}

** Delete an existing archive for a project. **

Parameters

Field Name Type Description Default
archiveId string Required Policy ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. 
GET https://cloud.appwrite.io/v1/backups/policies

** List all policies for a project. **

Parameters

Field Name Type Description Default
queries array Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. [] 
POST https://cloud.appwrite.io/v1/backups/policies

** Create a new backup policy. **

Parameters

Field Name Type Description Default
policyId string Policy ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
name string Policy name. Max length: 128 chars.
services array Array of services to backup
resourceId string Resource ID. When set, only this single resource will be backed up.
enabled boolean Is policy enabled? When set to 'disabled', no backups will be taken 1
retention integer Days to keep backups before deletion
schedule string Schedule CRON syntax. 
GET https://cloud.appwrite.io/v1/backups/policies/{policyId}

** Get a backup policy using it's ID. **

Parameters

Field Name Type Description Default
policyId string Required Policy ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. 
PATCH https://cloud.appwrite.io/v1/backups/policies/{policyId}

** Update an existing policy using it's ID. **

Parameters

Field Name Type Description Default
policyId string Required Policy ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
name string Policy name. Max length: 128 chars.
retention integer Days to keep backups before deletion
schedule string Cron expression
enabled boolean Is Backup enabled? When set to 'disabled', No backup will be taken 
DELETE https://cloud.appwrite.io/v1/backups/policies/{policyId}

** Delete a policy using it's ID. **

Parameters

Field Name Type Description Default
policyId string Required Policy ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. 
POST https://cloud.appwrite.io/v1/backups/restoration

** Create and trigger a new restoration for a backup on a project. **

Parameters

Field Name Type Description Default
archiveId string Backup archive ID to restore
services array Array of services to restore
newResourceId string Unique Id. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
newResourceName string Database name. Max length: 128 chars. 
GET https://cloud.appwrite.io/v1/backups/restorations

** List all backup restorations for a project. **

Parameters

Field Name Type Description Default
queries array Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. [] 
GET https://cloud.appwrite.io/v1/backups/restorations/{restorationId}

** Get the current status of a backup restoration. **

Parameters

Field Name Type Description Default
restorationId string Required Restoration ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.