backups

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

Overview

Name	backups
Type	Resource
Id	ovh.over_the_box.backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
backup_id	string	The id of the backup (wire: backupId)
device_action_id	string	The id of the device action that triggered the backup (wire: deviceActionId)
created_at	string (date-time)	Date of the creation of the backup (wire: createdAt)

list

Backup

Name	Datatype	Description
backup_id	string	The id of the backup (wire: backupId)
device_action_id	string	The id of the device action that triggered the backup (wire: deviceActionId)
created_at	string (date-time)	Date of the creation of the backup (wire: createdAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_id, service_name		Get a backup of an OverTheBox service. Returns the creation date of a configuration backup and the ID of the device action that triggered it.
list	select	service_name	x_pagination_mode	List the backups of an OverTheBox service. Returns the IDs of the configuration backups of the device of the service.
delete	delete	backup_id, service_name		Delete a backup of an OverTheBox service. Removes the configuration backup. It can no longer be restored on the device.

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.

Name	Datatype	Description
api_host	string	The 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_id	string	The id of the backup (wire: backupId)
service_name	string	The internal name of your overTheBox offer (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a backup of an OverTheBox service. Returns the creation date of a configuration backup and the ID of the device action that triggered it.

SELECT
backup_id,
device_action_id,
created_at
FROM ovh.over_the_box.backups
WHERE backup_id = '{{ backup_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List the backups of an OverTheBox service. Returns the IDs of the configuration backups of the device of the service.

SELECT
backup_id,
device_action_id,
created_at
FROM ovh.over_the_box.backups
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete a backup of an OverTheBox service. Removes the configuration backup. It can no longer be restored on the device.

DELETE FROM ovh.over_the_box.backups
WHERE backup_id = '{{ backup_id }}' --required
AND service_name = '{{ service_name }}' --required
;