Skip to main content

resource_website_backup_downloads

Creates, updates, deletes, gets or lists a resource_website_backup_downloads resource.

Overview​

Nameresource_website_backup_downloads
TypeResource
Idovh.managed_cms.resource_website_backup_downloads

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idstring (uuid)Unique identifier of the backup
database_download_urlstringURL to download the database of the backup, null while the backup is being created (wire: databaseDownloadURL)
expires_atstring (date-time)Date after which the backup is deleted, null while the backup is being created (wire: expiresAt)
files_download_urlstringURL to download the files of the backup, null while the backup is being created (wire: filesDownloadURL)
size_bytesintegerSize of the backup, in bytes, null while the backup is being created (wire: sizeBytes)
started_atstring (date-time)Date the backup was triggered at (wire: startedAt)
statusstringStatus of the backup (CREATING, READY)
typestringWhether the backup was taken automatically or requested by the customer (AUTOMATIC, MANUAL)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbackup_id, service_id, website_idReturns a backup of the website with its download links, one for its files and one for its database, available once the backup is READY. Backups are listed in the current state of the website. (Beta version)

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
backup_idstring (uuid)Identifier of the backup, as listed in the current state of the website (wire: backupId)
service_idstring (uuid)Service ID (wire: serviceId)
website_idstring (uuid)Website ID (wire: websiteId)

SELECT examples​

Returns a backup of the website with its download links, one for its files and one for its database, available once the backup is READY. Backups are listed in the current state of the website. (Beta version)

SELECT
id,
database_download_url,
expires_at,
files_download_url,
size_bytes,
started_at,
status,
type
FROM ovh.managed_cms.resource_website_backup_downloads
WHERE backup_id = '{{ backup_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND website_id = '{{ website_id }}' -- required
;