px pxb export

Export px-backup resources

note

The following commands support a set of global flags that apply to all px pxb commands. For details, see the Global Flags section.

px pxb export config

Export the current PX-Backup configuration to a YAML file.

By default, sensitive authentication tokens are redacted for security. Use --include-tokens to export tokens (not recommended for sharing).

Examples:

# Export config to a file (tokens redacted by default)
pxb export config --file config-backup.yaml

# Export config to stdout
pxb export config

# Export config with tokens (use with caution)
pxb export config --file config-backup.yaml --include-tokens

Flags

Flag	Input type	Description	Default	Required
--authtoken	string	oidc auth token	-	Optional
--dry-run	bool	Simulate the operation without making any changes	false	Optional
--endpoint, -e	string	The endpoint of the server	-	Optional
--file, -f	string	Output file path (default: stdout)	-	Optional
--include-tokens	bool	Include sensitive authentication tokens in export (not recommended)	false	Optional
--labels, -l	string	Comma separated list of labels as key-value pairs: 'k1=v1,k2=v2'	-	Optional
--orgID	string	The org id for which to query the object	default	Optional
--output, -o	string	Output format. One of: table|json|yaml|name	table	Optional
--tls-certificate	string	tls certificate	-	Optional