{"id":"15b1b7f9-8eae-437b-afe8-42a030d34b66","createdDate":"2024-10-10T13:41:43.981Z","updatedDate":"2024-10-10T13:41:43.981Z","resourceId":"876d92e7-1ef2-4a4c-a915-99fd8a3beb9a","api":{"schema":{"object":{"displayName":"Backup Object","description":"","slug":"backup-object","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackup","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git"},"methods":[{"summary":"List Backups","description":"Retrieves a list of all backups for a site.\n\nResults are sorted by requested date, with the newest first.\n\nYou can use this method to check whether a backup initiated with Create Backup has been completed successfully.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.ListBackups","parameters":[{"name":"status","in":"query","description":"Statuses to filter by.\nIf provided, only backups with the specified statuses are listed.\nFor example, to list only completed backups, use `?status=READY`.\nTo list completed and pending backups, use `?status=READY&status=PENDING`.\n\n- **`PENDING`**: A backup that was initiated but isn't yet completed.\n- **`READY`**: A successfully completed backup.\n- **`FAILED`**: A backup that was initiated but didn't successfully complete.\n- **`DELETED`**: A successfully deleted backup.\n- **`CANCELED`**: A backup that was canceled after being initiated.\n\nDefault: No filtering","required":false,"schema":{"description":"Statuses to filter by.\nIf provided, only backups with the specified statuses are listed.\nFor example, to list only completed backups, use `?status=READY`.\nTo list completed and pending backups, use `?status=READY&status=PENDING`.\n\n- **`PENDING`**: A backup that was initiated but isn't yet completed.\n- **`READY`**: A successfully completed backup.\n- **`FAILED`**: A backup that was initiated but didn't successfully complete.\n- **`DELETED`**: A successfully deleted backup.\n- **`CANCELED`**: A backup that was canceled after being initiated.\n\nDefault: No filtering","title":"status","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Status"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"type","in":"query","description":"Type to filter by. If provided, only backups of the specified type are listed.\n\n- **`AUTO`**: A backup taken automatically by the system on a regular schedule.\n- **`ON_DEMAND`**: A backup initiated manually.\n\nDefault: No filtering","required":false,"schema":{"description":"Type to filter by. If provided, only backups of the specified type are listed.\n\n- **`AUTO`**: A backup taken automatically by the system on a regular schedule.\n- **`ON_DEMAND`**: A backup initiated manually.\n\nDefault: No filtering","title":"type","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"Paging preferences.","required":false,"schema":{"description":"Paging preferences.","$ref":"#/components/schemas/upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.ListBackupsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_BACKUPS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.ListBackupsRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.ListBackupsResponse"},"legacyExamples":[{"name":"ListBackups","serviceName":"BackupService","type":"METHOD","content":{"title":"List all backups for a site","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/backups' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"backups\": [\n {\n \"id\": \"8c683199-dbd9-4591-883f-32b0298ecaf2\",\n \"requestedDate\": \"2022-05-25T15:12:06.797Z\",\n \"startedDate\": \"2022-05-25T15:12:07.025Z\",\n \"finishedDate\": null,\n \"deletedDate\": null,\n \"sizeInBytes\": null,\n \"status\": \"PENDING\",\n \"type\": \"ON_DEMAND\"\n },\n {\n \"id\": \"11384bcd-2106-416d-8ec6-19fbb7d92c20\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n }\n ],\n \"paging_metadata\": {\n \"count\": 2,\n \"offset\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"get","path":"/v2/backups","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_BACKUPS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.ListBackupsRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.ListBackupsResponse"},"legacyExamples":[{"name":"ListBackups","serviceName":"BackupService","type":"METHOD","content":{"title":"List all backups for a site","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/backups' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"backups\": [\n {\n \"id\": \"8c683199-dbd9-4591-883f-32b0298ecaf2\",\n \"requestedDate\": \"2022-05-25T15:12:06.797Z\",\n \"startedDate\": \"2022-05-25T15:12:07.025Z\",\n \"finishedDate\": null,\n \"deletedDate\": null,\n \"sizeInBytes\": null,\n \"status\": \"PENDING\",\n \"type\": \"ON_DEMAND\"\n },\n {\n \"id\": \"11384bcd-2106-416d-8ec6-19fbb7d92c20\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n }\n ],\n \"paging_metadata\": {\n \"count\": 2,\n \"offset\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"List Backups","slugifiedName":"list-backups"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Create Backup","description":"Creates an on-demand backup of live content in a site's collections.\n\n\nBy default, all of the site's collections are included in the backup. For a partial backup, specify which collections to include in the `backup.collections` parameter.\n\nThe process of creating a backup takes time.\nYou can check whether a backup has completed successfully with List Backups.\n\nYou can store up to 3 on-demand backups for each site.\nIf 3 on-demand backups already exist, the oldest existing on-demand backup for the site is deleted when a new one is created. Automated backups are not affected.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.CreateBackup","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.CreateBackupResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateBackupRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.CREATE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.CreateBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.CreateBackupResponse"},"legacyExamples":[{"name":"CreateBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Create a backup","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/backups' \\\n-H \"Accept: application/json\" \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"backup\": {\n \"id\": \"8af59df8-4915-45d1-b4d3-a31592d9311c\",\n \"requestedDate\": \"2022-07-27T13:14:59.903407Z\",\n \"startedDate\": null,\n \"finishedDate\": null,\n \"deletedDate\": null,\n \"sizeInBytes\": null,\n \"status\": \"PENDING\",\n \"type\": \"ON_DEMAND\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/backups","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.CREATE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.CreateBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.CreateBackupResponse"},"legacyExamples":[{"name":"CreateBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Create a backup","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/backups' \\\n-H \"Accept: application/json\" \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"backup\": {\n \"id\": \"8af59df8-4915-45d1-b4d3-a31592d9311c\",\n \"requestedDate\": \"2022-07-27T13:14:59.903407Z\",\n \"startedDate\": null,\n \"finishedDate\": null,\n \"deletedDate\": null,\n \"sizeInBytes\": null,\n \"status\": \"PENDING\",\n \"type\": \"ON_DEMAND\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Create Backup","slugifiedName":"create-backup"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Restore Backup","description":"Restores all data from a backup.\n\nThe process of restoring data from a backup takes time.\nYou can check whether your restoration has completed successfully with List Restorations.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.RestoreBackup","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"backupId","description":"ID of backup to be restored.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.RestoreBackupResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RestoreBackupRequest","description":"","properties":{},"deprecated":false,"required":["backupId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.RESTORE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupResponse"},"legacyExamples":[{"name":"RestoreBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Restore data from a backup","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/backups/restore/bfab4dac-c835-4cf7-8b47-adbe1ca1ea34' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"restoration\": {\n \"id\": \"0bd30197-2012-4c35-a4f0-a0d5ef7ecea0\",\n \"requestedDate\": \"2022-05-26T07:17:02.209Z\",\n \"startedDate\": null,\n \"finishedDate\": null,\n \"backup\": {\n \"id\": \"bfab4dac-c835-4cf7-8b47-adbe1ca1ea34\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"PENDING\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/backups/{backupId}/restore","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.RESTORE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupResponse"},"legacyExamples":[{"name":"RestoreBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Restore data from a backup","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v2/backups/restore/bfab4dac-c835-4cf7-8b47-adbe1ca1ea34' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"restoration\": {\n \"id\": \"0bd30197-2012-4c35-a4f0-a0d5ef7ecea0\",\n \"requestedDate\": \"2022-05-26T07:17:02.209Z\",\n \"startedDate\": null,\n \"finishedDate\": null,\n \"backup\": {\n \"id\": \"bfab4dac-c835-4cf7-8b47-adbe1ca1ea34\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"PENDING\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Restore Backup","slugifiedName":"restore-backup"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Restore Partial Backup","description":"Restores specific collections from a backup.\n\nThe process of restoring data from a backup takes time.\nYou can check whether your restoration has completed successfully with List Restorations.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.RestorePartialBackup","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"backupId","description":"ID of backup to be restored.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.RestoreBackupResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RestorePartialBackupRequest","description":"","properties":{"dataCollectionIds":{"description":"Collections to be restored.\n\n**Note**: If two collections have a multireference relation, the references will be restored only if both collections are restored.","minItems":1,"title":"dataCollectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["backupId","dataCollectionIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.RESTORE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.RestorePartialBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v2/backups/{backupId}/partial-restore","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.RESTORE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.RestorePartialBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.RestoreBackupResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Restore Partial Backup","slugifiedName":"restore-partial-backup"},"permissionScopes":[],"isAdminMethod":true},{"summary":"List Restorations","description":"Retrieves a list of all data restorations from backups.\n\nResults are sorted by requested date, with the newest first.\n\nYou can use this method to check whether a restoration initiated with Restore Backup has been completed successfully.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.ListRestorations","parameters":[{"name":"status","in":"query","description":"Statuses to filter by. If provided, only restorations with the specified statuses are listed.\nFor example, to list only completed restorations, use `?status=COMPLETED`.\nTo list completed and pending restorations, use `?status=COMPLETED&status=PENDING`.\n\n- **`PENDING`**: A restoration that was initiated but isn't yet completed.\n- **`COMPLETED`**: A successfully completed restoration.\n- **`FAILED`**: A restoration that was initiated but didn't successfully complete.\n\nDefault: No filtering","required":false,"schema":{"description":"Statuses to filter by. If provided, only restorations with the specified statuses are listed.\nFor example, to list only completed restorations, use `?status=COMPLETED`.\nTo list completed and pending restorations, use `?status=COMPLETED&status=PENDING`.\n\n- **`PENDING`**: A restoration that was initiated but isn't yet completed.\n- **`COMPLETED`**: A successfully completed restoration.\n- **`FAILED`**: A restoration that was initiated but didn't successfully complete.\n\nDefault: No filtering","title":"status","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration.Status"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"Offset and limit of items to retrieve.","required":false,"schema":{"description":"Offset and limit of items to retrieve.","$ref":"#/components/schemas/upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.ListRestorationsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_RESTORATIONS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.ListRestorationsRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.ListRestorationsResponse"},"legacyExamples":[{"name":"ListRestorations","serviceName":"BackupService","type":"METHOD","content":{"title":"List all restorations for a site","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/backups/restorations' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"restorations\": [\n {\n \"id\": \"0bd30197-2012-4c35-a4f0-a0d5ef7ecea0\",\n \"requestedDate\": \"2022-05-27T07:17:02.209Z\",\n \"startedDate\": \"2022-05-27T07:17:02.394Z\",\n \"finishedDate\": \"2022-05-27T07:17:03.452Z\",\n \"backup\": {\n \"id\": \"11384bcd-2106-416d-8ec6-19fbb7d92c20\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"PENDING\"\n },\n {\n \"id\": \"d51f5c89-1f7c-4610-a60e-92f81ad2231a\",\n \"requestedDate\": \"2022-05-26T07:17:02.209Z\",\n \"startedDate\": \"2022-05-26T07:17:02.394Z\",\n \"finishedDate\": \"2022-05-26T07:17:03.452Z\",\n \"backup\": {\n \"id\": \"acb5af51-3332-471d-aad4-9b3c52ff5b07\",\n \"requestedDate\": \"2022-05-24T15:10:56.394Z\",\n \"startedDate\": \"2022-05-24T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-24T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1087\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"COMPLETED\"\n }\n ],\n \"paging_metadata\": {\n \"count\": 2,\n \"offset\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"get","path":"/v2/backups/restorations","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_RESTORATIONS"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.ListRestorationsRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.ListRestorationsResponse"},"legacyExamples":[{"name":"ListRestorations","serviceName":"BackupService","type":"METHOD","content":{"title":"List all restorations for a site","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v2/backups/restorations' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"restorations\": [\n {\n \"id\": \"0bd30197-2012-4c35-a4f0-a0d5ef7ecea0\",\n \"requestedDate\": \"2022-05-27T07:17:02.209Z\",\n \"startedDate\": \"2022-05-27T07:17:02.394Z\",\n \"finishedDate\": \"2022-05-27T07:17:03.452Z\",\n \"backup\": {\n \"id\": \"11384bcd-2106-416d-8ec6-19fbb7d92c20\",\n \"requestedDate\": \"2022-05-25T15:10:56.394Z\",\n \"startedDate\": \"2022-05-25T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-25T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1584\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"PENDING\"\n },\n {\n \"id\": \"d51f5c89-1f7c-4610-a60e-92f81ad2231a\",\n \"requestedDate\": \"2022-05-26T07:17:02.209Z\",\n \"startedDate\": \"2022-05-26T07:17:02.394Z\",\n \"finishedDate\": \"2022-05-26T07:17:03.452Z\",\n \"backup\": {\n \"id\": \"acb5af51-3332-471d-aad4-9b3c52ff5b07\",\n \"requestedDate\": \"2022-05-24T15:10:56.394Z\",\n \"startedDate\": \"2022-05-24T15:10:56.603Z\",\n \"finishedDate\": \"2022-05-24T15:10:56.913Z\",\n \"deletedDate\": null,\n \"sizeInBytes\": \"1087\",\n \"status\": \"READY\",\n \"type\": \"ON_DEMAND\"\n },\n \"status\": \"COMPLETED\"\n }\n ],\n \"paging_metadata\": {\n \"count\": 2,\n \"offset\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"List Restorations","slugifiedName":"list-restorations"},"permissionScopes":[],"isAdminMethod":true},{"summary":"Delete Backup","description":"Deletes a backup.\n\nThe process of deleting a backup takes time.\nYou can check whether a backup has been deleted successfully with List Backups.","operationId":"com.wixpress.dstore.api.backup.v2.BackupService.DeleteBackup","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"backupId","description":"ID of the backup to be deleted.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.DeleteBackupResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v2/backups","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v2/backups","destinationPath":"/v2/backups","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Backup Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v2.backup","serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.data.v2.backup_deleted","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.DELETE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.DeleteBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.DeleteBackupResponse"},"legacyExamples":[{"name":"DeleteBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Delete a backup","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v2/backups/df941cc7-603e-4926-8034-8d8dc5025325' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"delete","path":"/v2/backups/{backupId}","rpcOnly":false,"triggeredEvents":[{"title":"Backup Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v2.backup","serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.data.v2.backup_deleted","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.DELETE_BACKUP"],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress:dstore-api","serviceArtifactId":"com.wixpress.dstore-backups","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.dstore.api.backup.v2.DeleteBackupRequest","responseMessage":"com.wixpress.dstore.api.backup.v2.DeleteBackupResponse"},"legacyExamples":[{"name":"DeleteBackup","serviceName":"BackupService","type":"METHOD","content":{"title":"Delete a backup","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v2/backups/df941cc7-603e-4926-8034-8d8dc5025325' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Delete Backup","slugifiedName":"delete-backup"},"permissionScopes":[],"isAdminMethod":true}],"webhooks":[{"summary":"Backup State Changed","title":"Backup Backup State Changed","description":"Triggered when a backup's status is changed. This includes when a backup is created and its status is set to `PENDING`.","permissions":[],"payload":{"schemaName":"com.wixpress.dstore.api.backup.v2.BackupStateChanged"},"exposure":"PUBLIC","maturity":"BETA","slug":"backup_state_changed","eventTopic":"domain_events_wix.data.v2.backup","serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.data.v2.backup_backup_state_changed","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.BackupStateChanged","contentLink":{"displayName":"Backup State Changed","slugifiedName":"backup-state-changed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Backup Restoration State Changed","title":"Backup Restoration State Changed","description":"Triggered when a restoration's status is changed. This includes when a new restoration is initiated and its status is `PENDING`.","permissions":[],"payload":{"schemaName":"com.wixpress.dstore.api.backup.v2.RestorationStateChanged"},"exposure":"PUBLIC","maturity":"BETA","slug":"restoration_state_changed","eventTopic":"domain_events_wix.data.v2.backup","serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.data.v2.backup_restoration_state_changed","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.RestorationStateChanged","contentLink":{"displayName":"Backup Restoration State Changed","slugifiedName":"backup-restoration-state-changed"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Backup Deleted","title":"Backup Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v2.backup","serviceName":"com.wixpress.dstore.api.backup.v2.BackupService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.data.v2.backup_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackup","contentLink":{"displayName":"Backup Deleted","slugifiedName":"backup-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Backups API\n\nThe Backups API enables your app to create and manage backups of the live content in a Wix site's collections.\n\nWith Backups, your app can:\n- [Create a backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::create-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/create-backup) of data in a Wix site's collections.\n- [Restore data](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::restore-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/restore-backup) from an existing backup.\n- Retrieve information about prior and ongoing [backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups) and [restorations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-restorations*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-restorations).\n\nBackups enable you to restore a Wix site's collections' content in the event of data corruption, erroneous deletions, or other mistakes.\n\nThe system creates a backup automatically every 7 days. In addition, you can use the Backups API to create an on-demand backup when significant changes are made to your data. For example:\n- If an automated backup is not scheduled soon, create an on-demand backup after updating your data, to ensure your new content is backed up as soon as possible.\n- Create an on-demand backup prior to a major update to a Wix site's collections, so you can restore your most recent pre-update data in the event something goes wrong during the update.\n\nFor information on how site owners can back up the content of a Wix site's collections using the Content Manager, see [Backing Up Your Collections](fallback::https://support.wix.com/en/article/content-manager-backing-up-your-collections).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n- Backups include only live content. They don't include content contained in the optional [sandbox](fallback::https://support.wix.com/en/article/content-manager-about-sandbox-and-live-collections-and-syncing).\n- Backups include only collection content. They don't store a collection's schema or named views.\n- A site can store a maximum of 3 on-demand backups. If 3 on-demand backups already exist and you create a new backup, the oldest existing on-demand backup is deleted.\n- When you restore data from a backup, the restoration process replaces the collection's current data with the data in the backup. So if you add items to a collection after initiating a backup, and then you restore data from that backup, the new content may be lost.\n- If any content is submitted to a collection during the restoration process, that content may be lost.\n\n## Terminology\n\n- **Backup:** A full copy of the live content contained in a Wix site's collections.\n - **Auto:** A backup taken automatically by the system on a regular schedule.\n - **On demand:** A backup initiated manually.\n- **Restoration:** Regeneration of a Wix site's collection content from a prior backup.","sourceRepo":"git@github.com:wix-private/cloud.git","path":"com/wixpress/dstore/docs/Intro.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article shares some possible use cases your app could support, as well as a sample flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.\n\n## Backing up data before a major update\n\nSuppose your app is about to update many items in a site's collections. For example, it is updating inventory with the most recent stock quantities in a store. Before such a major update, your app can back up site data as follows:\n\n1. Use [Create Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::create-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/create-backup) to generate a new on-demand backup of all live content in a Wix site's data collections.\n\n2. To check whether the new backup has been completed successfully, use [List Backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups). A completed backup's `status` property has the value `READY`. This means it can be used to restore the site's data.\n\n3. Continue managing site data as usual. In most cases, you shouldn't need the later steps!\n\n## Restoring data from a backup\n\nWhat if a site owner accidentally entered incorrect data? For example, suppose they inadvertently provided figures from the wrong month. Your app can provide the option of reverting site data to a prior state as follows:\n\n1. To restore site data from a backup, you first need to choose which backup to restore.\n\n Use [List Backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups) with the `status` parameter value `READY` to retrieve a list of all backups that can be used for a restoration, ordered from newest to oldest.\n\n You need the ID of the backup you wish to restore data from. If you wish to restore data from the most recent backup, save the ID of the first backup in the list.\n\n2. Use [Restore Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::restore-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/restore-backup) with the ID of the backup you wish to restore data from.\n\n3. To check whether the data restoration has been completed successfully, use [List Restorations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-restorations*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-restorations). A completed restoration's `status` property has the value `COMPLETED`. This means the content of site collections has reverted to its state at the time of the selected backup.\n\n4. After restoring data from a backup, you may wish to delete the backup you restored from. This way, you can retain older backups which may have been created at important junctures, while also freeing a slot for a new backup. To do this, use [Delete Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::delete-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/delete-backup) with the ID of the backup you restored data from.","sourceRepo":"git@github.com:wix-private/cloud.git","path":"com/wixpress/dstore/docs/SampleFlows.md"}],"components":{"schemas":{"com.wixpress.dstore.api.backup.v2.GCBackup":{"type":"object","properties":{"id":{"description":"","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GCBackup","description":""},"com.wixpress.dstore.api.backup.v2.CreateGCBackupRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"segment":{"description":"","title":"segment","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Segment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clusterId":{"description":"","title":"clusterId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"databaseName":{"description":"","title":"databaseName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateGCBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.Segment":{"type":"string","description":"","title":"Segment","enum":[{"order":0,"value":"Dev","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"Public","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.dstore.api.backup.v2.CreateGCBackupResponse":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateGCBackupResponse","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.dstore.api.backup.v2.GetGCBackupRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetGCBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.GCBackupResponse":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"segment":{"description":"","title":"segment","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Segment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clusterId":{"description":"","title":"clusterId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"databaseName":{"description":"","title":"databaseName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackupResponse.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"size":{"description":"","title":"size","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requestedDate":{"description":"","title":"requestedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finishedDate":{"description":"","title":"finishedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restorations":{"description":"","title":"restorations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackupResponse.Restoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GCBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.GCBackupResponse.Restoration.Status":{"type":"string","description":"","title":"Status","enum":[{"order":0,"value":"PENDING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"FAILED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"COMPLETED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"CANCELED","description":"","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.dstore.api.backup.v2.GCBackupResponse.Status":{"type":"string","description":"","title":"Status","enum":[{"order":0,"value":"PENDING","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"READY","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"FAILED","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"CANCELED","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.dstore.api.backup.v2.GCBackupResponse.Restoration":{"type":"object","properties":{"restorationId":{"description":"","format":"GUID","title":"restorationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clusterId":{"description":"","title":"clusterId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"databaseName":{"description":"","title":"databaseName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackupResponse.Restoration.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Restoration","description":""},"com.wixpress.dstore.api.backup.v2.FindGCBackupRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"segment":{"description":"","title":"segment","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Segment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clusterId":{"description":"","title":"clusterId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"databaseName":{"description":"","title":"databaseName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FindGCBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.FindGCBackupResponse":{"type":"object","properties":{"backups":{"description":"","title":"backups","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.GCBackupResponse"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FindGCBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.RestoreGCBackupRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clusterId":{"description":"","title":"clusterId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"databaseName":{"description":"","title":"databaseName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreGCBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.RestoreGCBackupResponse":{"type":"object","properties":{"restorationId":{"description":"","format":"GUID","title":"restorationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreGCBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.CancelGCBackupRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancelGCBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.CancelGCBackupResponse":{"type":"object","properties":{},"title":"CancelGCBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.CancelGCRestorationRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restorationId":{"description":"","format":"GUID","title":"restorationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancelGCRestorationRequest","description":""},"com.wixpress.dstore.api.backup.v2.CancelGCRestorationResponse":{"type":"object","properties":{},"title":"CancelGCRestorationResponse","description":""},"com.wixpress.dstore.api.backup.v2.DeleteExpiredBackupRecordsRequest":{"type":"object","properties":{},"title":"DeleteExpiredBackupRecordsRequest","description":""},"com.wixpress.dstore.api.backup.v2.DeleteExpiredBackupRecordsResponse":{"type":"object","properties":{},"title":"DeleteExpiredBackupRecordsResponse","description":""},"com.wixpress.dstore.api.backup.v2.Backup":{"type":"object","properties":{"id":{"description":"Backup ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Backup status.\n* `PENDING`: Backup creation is in progress.\n* `READY`: Backup has been created successfully and can be used for data restoration.\n* `FAILED`: Backup creation has failed.\n* `DELETED`: Backup has been deleted.\n* `CANCELED`: Backup has been canceled.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of backup, based on how it was triggered.\n* `ON_DEMAND`: Backup created on demand.\n* `AUTO`: Backup created automatically on a regular schedule.","readOnly":true,"title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requestedDate":{"description":"Date and time the backup was requested.","readOnly":true,"title":"requestedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startedDate":{"description":"Date and time the backup commenced. Value is `null` until the backup process begins in the background.","readOnly":true,"title":"startedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finishedDate":{"description":"Date and time the backup process finished. Value is `null` until the backup process is completed in the background.","readOnly":true,"title":"finishedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedDate":{"description":"Date and time the backup was deleted. Value is `null` if that backup hasn't been deleted.","readOnly":true,"title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sizeInBytes":{"description":"Backup size in bytes. Value is `null` until the backup process is completed.","readOnly":true,"title":"sizeInBytes","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collections":{"description":"IDs and display names of collections the backup contains.","readOnly":true,"title":"collections","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Collection"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Backup","description":""},"com.wixpress.dstore.api.backup.v2.Backup.Status":{"type":"string","description":"","title":"Status","enum":[{"order":0,"value":"PENDING","description":"Backup creation is in progress.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"READY","description":"Backup has been created successfully and can be used for data restoration.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"FAILED","description":"Backup creation has failed.","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"DELETED","description":"Backup has been deleted.","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"CANCELED","description":"Backup has been canceled.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.dstore.api.backup.v2.Backup.Type":{"type":"string","description":"","title":"Type","enum":[{"order":0,"value":"ON_DEMAND","description":"Backup taken on demand.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"AUTO","description":"Automatically triggered backup (taken repeatedly on a regular interval).","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.dstore.api.backup.v2.Collection":{"type":"object","properties":{"id":{"description":"Collection ID.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Collection display name.","readOnly":true,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Collection","description":""},"com.wixpress.dstore.api.backup.v2.DisableInstanceRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DisableInstanceRequest","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.dstore.api.backup.v2.EnableInstanceRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EnableInstanceRequest","description":""},"com.wixpress.dstore.api.backup.v2.DeleteAllRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteAllRequest","description":""},"com.wixpress.dstore.api.backup.v2.GetBackupMetadataRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetBackupMetadataRequest","description":""},"com.wixpress.dstore.api.backup.v2.GetBackupMetadataResponse":{"type":"object","properties":{"metaData":{"description":"","title":"metaData","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetBackupMetadataResponse","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.dstore.api.backup.v2.RebuildRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RebuildRequest","description":""},"com.wixpress.dstore.api.backup.v2.MoveRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveRequest","description":""},"com.wixpress.dstore.api.backup.v2.RemoveDeletedRequest":{"type":"object","properties":{"limit":{"description":"","title":"limit","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDeletedRequest","description":""},"com.wixpress.dstore.api.backup.v2.FailRestorationRequest":{"type":"object","properties":{"restorationId":{"description":"","format":"GUID","title":"restorationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FailRestorationRequest","description":""},"com.wixpress.dstore.api.backup.v2.TakeBackupRequest":{"type":"object","properties":{"instanceId":{"description":"","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TakeBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.UpdateBackupMetadataRequest":{"type":"object","properties":{"backupId":{"description":"","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"s3Region":{"description":"","title":"s3Region","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"s3Bucket":{"description":"","title":"s3Bucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateBackupMetadataRequest","description":""},"com.wixpress.dstore.api.backup.v2.BackupStateChanged":{"type":"object","properties":{"backup":{"description":"current state of backup","readOnly":true,"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup","summary":"backup","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BackupStateChanged","description":"event triggered when backup state is changed (i.e. it was created, started, completed or failed)"},"com.wixpress.dstore.api.backup.v2.RestorationStateChanged":{"type":"object","properties":{"restoration":{"description":"current state of restoration","readOnly":true,"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration","summary":"restoration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestorationStateChanged","description":"event triggered when backup restoration state is changed (i.e. it was created, started or completed)"},"com.wixpress.dstore.api.backup.v2.Restoration":{"type":"object","properties":{"id":{"description":"Restoration ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"backup":{"description":"Details of the backup used for the restoration.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup","summary":"backup","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Status of restoration.\n* `PENDING`: Restoration from a backup is in progress.\n* `COMPLETED`: Restoration from a backup has been successful.\n* `FAILED`: Restoration from a backup has failed.","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requestedDate":{"description":"Date and time the restoration was requested.","readOnly":true,"title":"requestedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startedDate":{"description":"Date and time the restoration commenced. Value is `null` until the restoration process begins in the background.","readOnly":true,"title":"startedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finishedDate":{"description":"Date and time the restoration finished. Value is `null` until the restoration process is completed in the background.","readOnly":true,"title":"finishedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"collections":{"description":"List of collections restored.","readOnly":true,"title":"collections","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Collection"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Restoration","description":""},"com.wixpress.dstore.api.backup.v2.Restoration.Status":{"type":"string","description":"","title":"Status","enum":[{"order":0,"value":"PENDING","description":"Restoration from a backup is in progress.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"COMPLETED","description":"Restoration from a backup has been successful.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"FAILED","description":"Restoration from a backup has failed.","maturity":"GA","exposure":"PUBLIC"}]},"com.wixpress.dstore.api.backup.v2.CreateBackupRequest":{"type":"object","properties":{},"title":"CreateBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.CreateBackupResponse":{"type":"object","properties":{"backup":{"description":"Details of the requested backup.","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup","summary":"backup","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.ListBackupsRequest":{"type":"object","properties":{"status":{"description":"Statuses to filter by.\nIf provided, only backups with the specified statuses are listed.\nFor example, to list only completed backups, use `?status=READY`.\nTo list completed and pending backups, use `?status=READY&status=PENDING`.\n\n- **`PENDING`**: A backup that was initiated but isn't yet completed.\n- **`READY`**: A successfully completed backup.\n- **`FAILED`**: A backup that was initiated but didn't successfully complete.\n- **`DELETED`**: A successfully deleted backup.\n- **`CANCELED`**: A backup that was canceled after being initiated.\n\nDefault: No filtering","title":"status","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Status"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type to filter by. If provided, only backups of the specified type are listed.\n\n- **`AUTO`**: A backup taken automatically by the system on a regular schedule.\n- **`ON_DEMAND`**: A backup initiated manually.\n\nDefault: No filtering","title":"type","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup.Type"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Paging preferences.","$ref":"#/components/schemas/upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListBackupsRequest","description":""},"upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.dstore.api.backup.v2.ListBackupsResponse":{"type":"object","properties":{"backups":{"description":"Retrieved backups.","title":"backups","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Backup"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListBackupsResponse","description":""},"upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wixpress.dstore.api.backup.v2.RestoreBackupRequest":{"type":"object","properties":{"backupId":{"description":"ID of backup to be restored.","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.RestoreBackupResponse":{"type":"object","properties":{"restoration":{"description":"Details of data restoration from backup.","$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration","summary":"restoration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.RestorePartialBackupRequest":{"type":"object","properties":{"backupId":{"description":"ID of backup to be restored.","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataCollectionIds":{"description":"Collections to be restored.\n\n**Note**: If two collections have a multireference relation, the references will be restored only if both collections are restored.","minItems":1,"title":"dataCollectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestorePartialBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.ListRestorationsRequest":{"type":"object","properties":{"status":{"description":"Statuses to filter by. If provided, only restorations with the specified statuses are listed.\nFor example, to list only completed restorations, use `?status=COMPLETED`.\nTo list completed and pending restorations, use `?status=COMPLETED&status=PENDING`.\n\n- **`PENDING`**: A restoration that was initiated but isn't yet completed.\n- **`COMPLETED`**: A successfully completed restoration.\n- **`FAILED`**: A restoration that was initiated but didn't successfully complete.\n\nDefault: No filtering","title":"status","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration.Status"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Offset and limit of items to retrieve.","$ref":"#/components/schemas/upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRestorationsRequest","description":""},"com.wixpress.dstore.api.backup.v2.ListRestorationsResponse":{"type":"object","properties":{"restorations":{"description":"Retrieved restorations.","title":"restorations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.dstore.api.backup.v2.Restoration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRestorationsResponse","description":""},"com.wixpress.dstore.api.backup.v2.DeleteBackupRequest":{"type":"object","properties":{"backupId":{"description":"ID of the backup to be deleted.","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.DeleteBackupResponse":{"type":"object","properties":{},"title":"DeleteBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.CancelBackupRequest":{"type":"object","properties":{"backupId":{"description":"ID of the backup to be cancelled.","format":"GUID","title":"backupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancelBackupRequest","description":""},"com.wixpress.dstore.api.backup.v2.CancelBackupResponse":{"type":"object","properties":{},"title":"CancelBackupResponse","description":""},"com.wixpress.dstore.api.backup.v2.MigrateNamespaceRequest":{"type":"object","properties":{"newNamespace":{"description":"","maxLength":255,"title":"newNamespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"existingNamespace":{"description":"","maxLength":255,"title":"existingNamespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MigrateNamespaceRequest","description":""},"com.wixpress.dstore.api.backup.v2.MigrateNamespaceResponse":{"type":"object","properties":{},"title":"MigrateNamespaceResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Backup","description":"","fqdn":"wix.data.v2.backup"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Backups API\n\nThe Backups API enables your app to create and manage backups of the live content in a Wix site's collections.\n\nWith Backups, your app can:\n- [Create a backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::create-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/create-backup) of data in a Wix site's collections.\n- [Restore data](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::restore-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/restore-backup) from an existing backup.\n- Retrieve information about prior and ongoing [backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups) and [restorations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-restorations*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-restorations).\n\nBackups enable you to restore a Wix site's collections' content in the event of data corruption, erroneous deletions, or other mistakes.\n\nThe system creates a backup automatically every 7 days. In addition, you can use the Backups API to create an on-demand backup when significant changes are made to your data. For example:\n- If an automated backup is not scheduled soon, create an on-demand backup after updating your data, to ensure your new content is backed up as soon as possible.\n- Create an on-demand backup prior to a major update to a Wix site's collections, so you can restore your most recent pre-update data in the event something goes wrong during the update.\n\nFor information on how site owners can back up the content of a Wix site's collections using the Content Manager, see [Backing Up Your Collections](fallback::https://support.wix.com/en/article/content-manager-backing-up-your-collections).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n- Backups include only live content. They don't include content contained in the optional [sandbox](fallback::https://support.wix.com/en/article/content-manager-about-sandbox-and-live-collections-and-syncing).\n- Backups include only collection content. They don't store a collection's schema or named views.\n- A site can store a maximum of 3 on-demand backups. If 3 on-demand backups already exist and you create a new backup, the oldest existing on-demand backup is deleted.\n- When you restore data from a backup, the restoration process replaces the collection's current data with the data in the backup. So if you add items to a collection after initiating a backup, and then you restore data from that backup, the new content may be lost.\n- If any content is submitted to a collection during the restoration process, that content may be lost.\n\n## Terminology\n\n- **Backup:** A full copy of the live content contained in a Wix site's collections.\n - **Auto:** A backup taken automatically by the system on a regular schedule.\n - **On demand:** A backup initiated manually.\n- **Restoration:** Regeneration of a Wix site's collection content from a prior backup."},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article shares some possible use cases your app could support, as well as a sample flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.\n\n## Backing up data before a major update\n\nSuppose your app is about to update many items in a site's collections. For example, it is updating inventory with the most recent stock quantities in a store. Before such a major update, your app can back up site data as follows:\n\n1. Use [Create Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::create-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/create-backup) to generate a new on-demand backup of all live content in a Wix site's data collections.\n\n2. To check whether the new backup has been completed successfully, use [List Backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups). A completed backup's `status` property has the value `READY`. This means it can be used to restore the site's data.\n\n3. Continue managing site data as usual. In most cases, you shouldn't need the later steps!\n\n## Restoring data from a backup\n\nWhat if a site owner accidentally entered incorrect data? For example, suppose they inadvertently provided figures from the wrong month. Your app can provide the option of reverting site data to a prior state as follows:\n\n1. To restore site data from a backup, you first need to choose which backup to restore.\n\n Use [List Backups](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-backups*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-backups) with the `status` parameter value `READY` to retrieve a list of all backups that can be used for a restoration, ordered from newest to oldest.\n\n You need the ID of the backup you wish to restore data from. If you wish to restore data from the most recent backup, save the ID of the first backup in the list.\n\n2. Use [Restore Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::restore-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/restore-backup) with the ID of the backup you wish to restore data from.\n\n3. To check whether the data restoration has been completed successfully, use [List Restorations](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::list-restorations*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/list-restorations). A completed restoration's `status` property has the value `COMPLETED`. This means the content of site collections has reverted to its state at the time of the selected backup.\n\n4. After restoring data from a backup, you may wish to delete the backup you restored from. This way, you can retain older backups which may have been created at important junctures, while also freeing a slot for a new backup. To do this, use [Delete Backup](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::876d92e7-1ef2-4a4c-a915-99fd8a3beb9aslug::delete-backup*fallback::https://dev.wix.com/docs/rest/business-solutions/cms/backup-v2/delete-backup) with the ID of the backup you restored data from."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}