list-workspace-backups¶

Description¶

List backup snapshots of a workbench.

Synopsis¶

  list-workspace-backups
[--environment-name <value>]
[--workspace-name <value>]
[--workspace-crn <value>]
[--query-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The environment for the workbench to list backups for.

--workspace-name (string)

The name of the workbench to list backups for.

--workspace-crn (string)

The CRN of the workbench to list backups for. If this field is specified, environment-name and workspace-name are ignored.

--query-options (object)

Query options object for ListWorkspaceBackups method.

expandEnvironmentMetadata -> (boolean)

When set to true, will return the metadata of the environment where the backed-up workbench is/was present.

Shorthand Syntax:

expandEnvironmentMetadata=boolean

JSON Syntax:

{
  "expandEnvironmentMetadata": true|false
}

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

backups -> (array)

The list of backups along with their details.

item -> (object)

Backup Detail response object for listing backups.

backupCrn -> (string)

The CRN of the backup snapshot.

backupName -> (string)

The name of the backup snapshot.

createdAt -> (datetime)

The creation time of the backup snapshot.

creatorCrn -> (string)

The CRN of the creator.

workspaceVersionAtBackup -> (string)

The version of the backed-up workbench at the time of backup.

backupStatus -> (string)

The status of the backup.

Form Factors¶

public, private