API Reference

Task API Reference

Task Specification

Field	Type	Required	Description	Example
metadata.name	string	Yes	Unique name for the task	mongodb-restore-emergency
metadata.namespace	string	Yes	Namespace where task is created	resiliency-system
spec.templateRef.templateName	string	Yes	Template to use for the task	mongodb-restore
spec.templateRef.params	array	Yes	Array of parameters for the template	See parameters table below
spec.placement.clusterName	string	No	Target cluster ID	5b2613a542a883618f0fe1da26396a721d063219
spec.placement.credentialName	string	No	Cluster credential name	cluster-admin

Parameters (MongoDB Backup Task)

Parameter	Type	Required	Description	Example
mongodb-asset	Asset	Yes	The MongoDB asset to backup	44bd1dd01554be8285626843082c5eaca28f6779
mongodb-credential	Credential	Yes	The credential name to access MongoDB	mongodb-root
mongodb-database	String	Yes	The database name to access backup	production
mongodb-opts	String	No	The opts for MongoDB backup	--gzip --oplog
bucket-asset	Asset	Yes	The Bucket asset where backups will be saved	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/mongodb
use-gzip	Bool	Yes	Enable GZIP compression	true
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (MongoDB Restore Task)

Parameter	Type	Required	Description	Example
mongodb-asset	Asset	Yes	The MongoDB asset where backup will be restored	44bd1dd01554be8285626843082c5eaca28f6779
mongodb-credential	Credential	Yes	The credential name to access MongoDB	mongodb-root
mongodb-database	String	Yes	The database name to access backup	production
mongodb-restore-opts	String	No	The opts for MongoDB restore	--drop --gzip
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
restore-path	String	No	Restore from the given path in given bucket path	/backups/mongodb/2025-06-24.archive
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (PostgreSQL Backup Task)

Parameter	Type	Required	Description	Example
postgresql-asset	Asset	Yes	The PostgreSQL asset to backup	44bd1dd01554be8285626843082c5eaca28f6779
postgresql-credential	Credential	Yes	The credential name to access PostgreSQL	postgres-admin
postgresql-database	String	Yes	The database name to access backup	production
postgresql-cli-version	String	No	The version for PostgreSQL client version	15
postgresql-opts	String	No	The opts for PostgreSQL backup	--verbose --single-transaction
bucket-asset	Asset	Yes	The Bucket asset where backups will be saved	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/postgresql
use-gzip	Bool	Yes	Enable GZIP compression	true
pvc-storage-class	string	No	Storage class for backup volume	standard
pvc-size	string	No	Storage size for backup volume	10
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (PostgreSQL Restore Task)

Parameter	Type	Required	Description	Example
postgresql-asset	Asset	Yes	The PostgreSQL asset where backup will be restored	44bd1dd01554be8285626843082c5eaca28f6779
postgresql-credential	Credential	Yes	The credential name to access PostgreSQL	postgres-admin
postgresql-database	String	Yes	The database name to access backup	production
postgresql-cli-version	String	No	The version for PostgreSQL client version	15
postgresql-restore-opts	String	No	The opts for PostgreSQL restore	--clean --if-exists
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
restore-path	Path	Yes	The path inside the bucket where backup is saved	/backups/postgresql/2025-06-24.archive
pvc-storage-class	string	No	Storage class for backup volume	standard
pvc-size	string	No	Storage size for backup volume	10
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (MySQL Backup Task)

Parameter	Type	Required	Description	Example
mysql-asset	Asset	Yes	The MySQL asset to backup	44bd1dd01554be8285626843082c5eaca28f6779
mysql-credential	Credential	Yes	The credential name to access MySQL	mysql-root
mysql-backup-opts	String	No	The opts for MySQL backup	--single-transaction --routines
bucket-asset	Asset	Yes	The Bucket asset where backups will be saved	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/mysql
use-gzip	Bool	Yes	Enable GZIP compression	true
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (MySQL Restore Task)

Parameter	Type	Required	Description	Example
mysql-asset	Asset	Yes	The MySQL asset where backup will be restored	44bd1dd01554be8285626843082c5eaca28f6779
mysql-credential	Credential	Yes	The credential name to access MySQL	mysql-root
mysql-restore-opts	String	No	The opts for MySQL restore	--force
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/mysql
restore-path	String	No	Restore from the latest backup found at a given time in the given bucket path	/backups/mysql/2025-06-24
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (SQL Server Backup Task)

Parameter	Type	Required	Description	Example
sqlserver-asset	Asset	Yes	The SQL Server asset asset to backup	d55be83a123f11eda91b0242ac120002
sqlserver-credential	Credential	Yes	The credential name to access SQL Server	sqlserver-identity
sqlserver-database	String	Yes	The database name to restore	production
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
restore-path	String	Yes	Path inside the bucket where the backup is stored	/backups/sqlserver
use-gzip	Bool	Yes	Enable GZIP compression	true
pvc-storage-class	String	No	Storage class for temporary volume	standard
pvc-size	String	No	Volume size (e.g., 10Gi)	10
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "200m", "memory": "512Mi"}}

Parameters (SQL Server Restore Task)

Parameter	Type	Required	Description	Example
sqlserver-asset	Asset	Yes	The SQL Server asset where backup will be restored	d55be83a123f11eda91b0242ac120002
sqlserver-credential	Credential	Yes	The credential name to access SQL Server	sqlserver-identity
sqlserver-database	String	Yes	The database name to restore	production
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
restore-path	String	Yes	Path inside the bucket where the backup is stored	/backups/sqlserver/2025-07-28.archive
pvc-storage-class	String	No	Storage class for temporary volume	standard
pvc-size	String	No	Volume size (e.g., 10Gi)	10
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "200m", "memory": "512Mi"}}

Parameters (Redis Backup Task)

Parameter	Type	Required	Description	Example
redis-asset	Asset	Yes	The Redis asset to backup	44bd1dd01554be8285626843082c5eaca28f6779
redis-credential	Credential	Yes	The credential name to access Redis	redis-auth
redis-backup-opts	String	No	The opts for Redis backup	--rdb --append-only
bucket-asset	Asset	Yes	The Bucket asset where backups will be saved	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/redis
use-gzip	Bool	Yes	Enable GZIP compression	true
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}

Parameters (Redis Restore Task)

Parameter	Type	Required	Description	Example
redis-asset	Asset	Yes	The Redis asset where backup will be restored	44bd1dd01554be8285626843082c5eaca28f6779
redis-credential	Credential	Yes	The credential name to access Redis	redis-auth
redis-restore-opts	String	No	The opts for Redis restore	--flush-before-restore
bucket-asset	Asset	Yes	The Bucket asset where backups are stored	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	Credential	Yes	The credential name to access Bucket	aws-s3-backup
bucket-path	Path	Yes	The path inside the bucket where backup is saved	/backups/redis
restore-path	String	No	Restore from the given path in given bucket path	/backups/redis/2025-06-24
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}