API Reference

Policy Specification

Field	Type	Required	Description	Example
metadata.name	string	Yes	Unique name for the policy	mongodb-backup-daily
metadata.namespace	string	Yes	Namespace where policy is created	resiliency-system
spec.templateName	string	Yes	Template to use for the policy	mongodb-backup
spec.suspended	boolean	No	Whether the policy is suspended	false
spec.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
spec.placement.createNamespace	boolean	No	Create namespace if it doesn't exist	true

Parameters (MongoDB Backup)

Parameter	Type	Required	Description	Example
mongodb-asset	string	Yes	ID of the MongoDB asset	44bd1dd01554be8285626843082c5eaca28f6779
mongodb-database	string	Yes	Database name to backup	production
mongodb-credential	string	Yes	Credential name for MongoDB access	mongodb-root
bucket-asset	string	Yes	ID of the bucket asset	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	string	Yes	Credential name for bucket access	aws-s3-backup
bucket-path	string	Yes	Path within bucket for backups	/backups/mongodb
schedule	string (cron)	Yes	Backup schedule in cron format	0 2 * * *
mongodb-opts	string	No	Additional mongodump options	--gzip --oplog
use-gzip	boolean	No	Enable GZIP compression	true

Parameters (PostgreSQL Backup)

Parameter	Type	Required	Description	Example
postgresql-asset	string	Yes	ID of the PostgreSQL asset	44bd1dd01554be8285626843082c5eaca28f6779
postgresql-database	string	Yes	Database name to backup	production
postgresql-credential	string	Yes	Credential name for PostgreSQL access	postgres-admin
bucket-asset	string	Yes	ID of the bucket asset	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	string	Yes	Credential name for bucket access	aws-s3-backup
bucket-path	string	Yes	Path within bucket for backups	/backups/postgresql
schedule	string (cron)	Yes	Backup schedule in cron format	0 2 * * *
postgresql-opts	string	No	Additional pg_dump options	--verbose --single-transaction
postgresql-version	string	No	PostgreSQL client version	15
use-gzip	boolean	No	Enable GZIP compression	true

Parameters (MySQL Backup)

Parameter	Type	Required	Description	Example
mysql-asset	string	Yes	ID of the MySQL asset	44bd1dd01554be8285626843082c5eaca28f6779
mysql-database	string	Yes	Database name to backup	production
mysql-credential	string	Yes	Credential name for MySQL access	mysql-root
bucket-asset	string	Yes	ID of the bucket asset	01409a2b09f336c6533729d4c04866803ec8bf67
bucket-credential	string	Yes	Credential name for bucket access	aws-s3-backup
bucket-path	string	Yes	Path within bucket for backups	/backups/mysql
schedule	string (cron)	Yes	Backup schedule in cron format	0 2 * * *
mysql-opts	string	No	Additional mysqldump options	--single-transaction --routines
mysql-version	string	No	MySQL client version	8.0
use-gzip	boolean	No	Enable GZIP compression	true

Parameters (Redis Backup Policy)

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
bucket-asset	Asset	Yes	The Bucket asset where backups will be saved	01409a2b09f336c6533729d4c04866803ec8bf67
redis-backup-opts	String	No	The opts for Redis backup	--rdb --append-only
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
schedule	Schedule	Yes	The backup schedule in Cron format	0 2 * * *
use-gzip	Bool	Yes	Enable GZIP compression	true
kubernetes-resources	KubernetesResources	Yes	Computational resources to be used	{"requests": {"cpu": "100m", "memory": "128Mi"}}