px pxb unshare

Unshare resources from users and groups

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 unshare backup

Unshare a backup by revoking sharing permissions from users and groups.

This command allows you to revoke access to backups by removing specific users, groups, or all sharing permissions entirely. You can specify individual users/groups to remove or use flags to remove all permissions at once.

The command supports both CLI flags and YAML/JSON file input for complex configurations.

Examples:

# Remove specific groups from backup access
pxb unshare backup --name my-backup --uid backup-12345 --remove-groups team1,team2

# Remove specific collaborators from backup access
pxb unshare backup --name my-backup --uid backup-12345 --remove-collaborators user-123,user-456

# Remove all group access
pxb unshare backup --name my-backup --uid backup-12345 --remove-all-groups

# Remove all collaborator access
pxb unshare backup --name my-backup --uid backup-12345 --remove-all-collaborators

# Remove all sharing permissions
pxb unshare backup --name my-backup --uid backup-12345 --remove-all-groups --remove-all-collaborators

# Unshare from configuration file
pxb unshare backup --file /path/to/backup-share-delete-config.json

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	string	Path to YAML/JSON file containing backup share unshare configuration	-	Optional
--labels, -l	string	Comma separated list of labels as key-value pairs: 'k1=v1,k2=v2'	-	Optional
--name, -n	string	Name of the backup (required, optional with --file)	-	Yes
--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
--remove-all-collaborators	bool	Remove all collaborator access permissions	false	Optional
--remove-all-groups	bool	Remove all group access permissions	false	Optional
--remove-collaborators	stringSlice	Remove specific collaborators from backup access (list of user IDs)	[]	Optional
--remove-groups	stringSlice	Remove specific groups from backup access (list of group IDs)	[]	Optional
--tls-certificate	string	tls certificate	-	Optional
--uid, -u	string	UID of the backup	-	Optional

px pxb unshare cluster

Unshare a cluster from users and groups, removing their access.

Examples:

  # Unshare cluster from users
  pxb unshare cluster --cluster my-cluster --cluster-uid cluster-123 --users user-123,user-456

  # Unshare cluster from groups
  pxb unshare cluster --cluster my-cluster --cluster-uid cluster-123 --groups team1,team2

  # Unshare cluster from users and groups
  pxb unshare cluster --cluster my-cluster --cluster-uid cluster-123 --users user-123 --groups team1

  # Unshare cluster from JSON file
  pxb unshare cluster --file cluster-unshare-config.json

Flags

Flag	Input type	Description	Default	Required
--authtoken	string	oidc auth token	-	Optional
--cluster, -c	string	Name of the cluster	-	Optional
--cluster-uid, -u	string	UID of the cluster	-	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	YAML/JSON file containing cluster unshare configuration	-	Optional
--groups	stringSlice	Group IDs to remove cluster access from (comma-separated)	[]	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
--users	stringSlice	User IDs to remove cluster access from (comma-separated)	[]	Optional