Backups Endpoint
Published 04 April 2024
The backups endpoint provided information about the latest backup on a monitored entity. Additional documentation for this endpoint can be found by navigating to http://your-web-server:port/api-docs.
/api/v1/backups
Parameters
| Name | Mandatory/Optional | Type | Default | Description |
|---|---|---|---|---|
| MonitoredEntityId | Optional | String | None | Monitored entity ID which can be retrieved from the monitored entities endpoint, can be used to restrict the result to a single monitored entity |
Attributes
| monitoredEntity | id and name of the monitored entity the backup was taken on. |
|---|---|
| groupName | The group the monitored entity belongs to. |
| clusterName | Name of the cluster on which the database is located, empty if there is no cluster |
| databaseName | The name of the database the backup was taken. |
| recoveryModel | The recovery model of the database backup, possible values are Full, Simple, Bulk Logged |
| latestFullBackup | The information of the latest full backup, possible values are BackInfo or null |
| latestLogBackup | The information of the latest log backup, possible values are BackInfo or null |
| latestDifferencialBackup | The information of the latest differential backup, possible values are BackInfo or null |
| maxRpo | Maximum recovery point objective of the backup in minutes |
BackUpInfo
| startDate | The time the backup process started |
|---|---|
| endDate | The time the backup process ended |
| duration | Total time taken for the backup process in seconds |
| size | The size of the backup in bytes |
| nativeBackup | True if the backup was taken natively |
backedUpByRedgateSqlBackup | True if the back was taken using Redgate SQL Backup |
Limitation
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
|---|---|
| Monitored entities | Currently supports SQL Server, Amazon RDS, Azure SQL Database and Azure Managed Instances |
