Get Backup Policies

Table 1. API: GET AZURE Backup Policies
Element Description
API GetAzureBackupPolicy
Description API returns AZURE backup policy(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/azure/provisioningEndPoints/{endpointId}/backupPolicys
URL Parameters (fields in curly {} braces)
  • endPointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "regionname=’eastus’","sortorder": "desc", "pagenumber”: "1", "pagesize" : "10"}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response

A Sample Response:

{
 "totalRecords": 3,
 "records": [
 {
 "entityId": "RBPP-71298B0D-C1FE-4A6A-B974-373D66BBD97F",
 "name": "daily backup",
 "regionName": "eastus",
 "recoveryVaultName": "-recovery-vault",
 "id": 1,
 "actualIdOnEnvironment": "daily backup",
 "backupFrequency": "Daily",
 "backupTime": "16:00:00",
 "retentionDailyBackup": "Y",
 "retentionDailyBackupPointForDays": "7",
 "retentionWeeklyBackup": "N",
 "retentionWeeklyBackupOn": "",
 "retentionWeeklyBackupAt": "00:00:00",
 "retentionWeeklyBackupPointForWeeks": "12",
 "retentionMonthlyBackup": "N",
 "retentionMonthlyBackupBase": " ",
 "retentionMonthlyBackupOn": "",
 "retentionMonthlyBackupDay": "",
 "retentionMonthlyBackupAt": "00:00:00",
 "retentionMonthlyBackupPointForMonths": "60",
 "retentionYearlyBackup": "N",
 "retentionYearlyBackupBase": " ",
 "retentionYearlyBackupIn": "",
 "retentionYearlyBackupOn": "",
 "retentionYearlyBackupDay": "",
 "retentionYearlyBackupAt": "00:00:00",
 "retentionYearlyBackupPointForYears": "10",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
 "tags": [],
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}
Response Parameters
  • Result:
  • entityId
  • name
  • regionName
  • recoveryVaultName
  • id
  • actualIdOnEnvironment
  • backupFrequency
  • backupTime
  • retentionDailyBackup
  • retentionDailyBackupPointForDays
  • retentionWeeklyBackup
  • retentionWeeklyBackupOn
  • retentionWeeklyBackupAt
  • retentionWeeklyBackupPointForWeeks
  • retentionMonthlyBackup
  • retentionMonthlyBackupBase
  • retentionMonthlyBackupOn
  • retentionMonthlyBackupDay
  • retentionMonthlyBackupAt
  • retentionMonthlyBackupPointForMonths
  • retentionYearlyBackup
  • retentionYearlyBackupBase
  • retentionYearlyBackupIn
  • retentionYearlyBackupOn
  • retentionYearlyBackupDay
  • retentionYearlyBackupAt
  • retentionYearlyBackupPointForYears
  • platformEntityId
  • tags
  • associatedServicePlans