Assets

This page documents the following assets:

• Filesystem Backup — A save set that defines the list of paths to backup following a plan.
• Filesystem Save Set — A save set that defines the list of paths to backup following a plan.
• Job — A backup (or restore) job that ran on a resource.
• Plan — A backup plan that defines the schedules and the retention of backups.
• Resource — A server registered with the backup service that can be used as a backup target.

Filesystem Backup

A save set that defines the list of paths to backup following a plan.

Schema

The following properties describe a Filesystem Backup:

Property	Type	Description
location Computed	object	Where the backups are stored.
name RequiredForceNew	string	Name of the save set. Examples:app-logs
paths Required	list(string)	The list of paths to backup. Examples:["/var/log","/etc"]
resource_id RequiredForceNew	string	The ID of the resource this save set applies to, typically a server hostname. This server should exists in the inventory and be registered with the backup service. Examples:cvtest0252e2.csbackup.sb.eu.ginfra.net
retention RequiredForceNew	integer	Number of days of retention. Examples:7
schedule RequiredForceNew	object	When the backups run.
status Computed	string	Whether the scheduled backups for this save set are enabled or disabled.

Examples

---

Filesystem Save Set

A save set that defines the list of paths to backup following a plan.

Schema

The following properties describe a Filesystem Save Set:

Property	Type	Description
location Computed	object	Where the backups are stored.
name RequiredForceNew	string	Name of the save set. Examples:app-logs
paths Required	list(string)	The list of paths to backup. Examples:["/var/log","/etc"]
resource_id RequiredForceNew	string	The ID of the resource this save set applies to, typically a server hostname. This server should exists in the inventory and be registered with the backup service. Examples:cvtest0252e2.csbackup.sb.eu.ginfra.net
retention RequiredForceNew	integer	Number of days of retention. Examples:7
schedule RequiredForceNew	object	When the backups run.
status Computed	string	Whether the scheduled backups for this save set are enabled or disabled.

Examples

---

Job

A backup (or restore) job that ran on a resource.

Schema

The following properties describe a Job:

Property	Type	Description
app_type_name Computed	string	Application type.
backup_level_name Computed	string	Backup level (e.g. Full, Incremental). Present for backup jobs only.
backup_name Required	string	Name of the backup this job ran on.
elapsed_time Computed	integer	Elapsed time of the job in seconds.
end_date_time Computed	string	ISO 8601 UTC timestamp of the job end (e.g. 2026-06-19T21:47:44Z).
error Computed	string	Reason the job is pending or failed.
resource_id Required	string	Hostname of the resource this job ran on.
start_date_time Computed	string	ISO 8601 UTC timestamp of the job start (e.g. 2026-06-19T21:47:44Z).
status Computed	string	Final status of the job.
type Required	string	Type of the job (e.g. Backup).

Examples

---

Plan

A backup plan that defines the schedules and the retention of backups.

Schema

The following properties describe a Plan:

Property	Type	Description
location ComputedForceNew	object	Where the backups are stored.
name Computed	string	Name of the backup plan. This is computed, based on location, retention and schedule.
retention RequiredForceNew	integer	Number of days of retention. Examples:7
schedule RequiredForceNew	object	When the backups run.

Examples

---

Resource

A server registered with the backup service that can be used as a backup target.

Schema

The following properties describe a Resource:

Property	Type	Description
name Required	string	Display name of the server in the backup service.

Examples