Backup Files
This resource lets you access the database backup files. The user account that performs the operation must have Low-level Read Administration permissions.
Resource | /api/admin/databaseBackup/backups |
Returned entity | BackupFile. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
BackupFile attributes
Represents the backup file.
This table describes attributes of the BackupFile
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
name | String | Name of the backup file. |
size | Long | Size of the file. |
creationDate | Long | The timestamp when the backup file was created. |
link | String | The link to the backup file. |
Read a List of BackupFiles
Get the list of all available backup files.
Required permissions
Requires Low-level Admin Read permission.
Request syntax
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of BackupFile attributes that should be returned in the response. If no field is specified,only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. |