---
title: System.Backups
slug: ps/help/en_us/vtm/controlapi/systembackups
docTags: 
createdAt: 2026-08-02T08:52:22.397Z
---

URI: http\://soap.zeus.com/zxtm/1.0/System/Backups/

The Backups interfaces provide operations on saved configuration backup archives.

### Methods

### createBackup( name, description ) throws ObjectAlreadyExists, InvalidObjectName

Create backup archive based on the current configuration

```bash
void createBackup(
String name
String description
)
```

### deleteAllBackups()

Delete all the backups

```bash
void deleteAllBackups()
```

### deleteBackups( names ) throws ObjectDoesNotExist

Delete one or more backups

```bash
void deleteBackups(
String[] names
)
```

### downloadBackup( name ) throws ObjectDoesNotExist

Download a named backup archive

```bash
Binary Data downloadBackup(
String name
)
```

### getBackupDetails( names )

Get details for one or more backups.

```bash
System.Backups.Backup[] getBackupDetails(
String[] names
)
```

### listAllBackups()

List the details for all backup archives.

```bash
System.Backups.Backup[] listAllBackups()
```

### restoreBackup( name ) throws ObjectDoesNotExist

Restore the named backup archive to be the current configuration

```bash
void restoreBackup(
String name
)
```

### uploadBackup( name, backup ) throws InvalidObjectName, ObjectAlreadyExists, InvalidInput

Upload a backup archive

```bash
void uploadBackup(
String name
Binary Data backup
)
```

### Structures

### System.Backups.Backup

This structure contains the information for each configuration backup archive.

```bash
struct System.Backups.Backup {
# The backup filename.
String name;
# The description for this backup.
String description;
# The date this backup was created.
Time date;
# The version of this backup archive.
String version;
}
```