List Backup Policies

POST

https://{account-domain}.console.eon.io/api/v1/projects/:projectId/backup-policies/list

POST

/api/v1/projects/:projectId/backup-policies/list

curl -X POST "https://{account-domain}.console.eon.io/api/v1/projects/6b3ea428-f6a4-5bb5-8fb2-e4d5d2d920ce/backup-policies/list?pageSize=10&pageToken=Yjk3ODZjNjktZTIwZC00NjAxLWE1MzktZjg2NGExM2IxYTZlfDE" \
     -H "Authorization: Bearer <token>"

200Successful

{
  "backupPolicies": [
    {
      "id": "de308488-df3d-5b82-8f37-477ef529f491",
      "name": "Production with PII",
      "enabled": true,
      "resourceSelector": {
        "resourceSelectionMode": "CONDITIONAL",
        "expression": {
          "group": {
            "operator": "AND",
            "operands": [
              {
                "resourceType": {
                  "operator": "IN",
                  "resourceTypes": [
                    "AWS_EC2",
                    "AWS_RDS"
                  ]
                }
              },
              {
                "environment": {
                  "operator": "IN",
                  "environments": [
                    "PROD",
                    "PROD_INTERNAL"
                  ]
                }
              }
            ]
          },
          "resourceType": {
            "operator": "IN",
            "resourceTypes": [
              "AWS_EC2"
            ]
          },
          "dataClasses": {
            "operator": "CONTAINS_ANY_OF",
            "dataClasses": [
              "PII"
            ]
          },
          "environment": {
            "operator": "IN",
            "environments": [
              "PROD"
            ]
          },
          "apps": {
            "operator": "CONTAINS_ANY_OF",
            "apps": [
              "string"
            ]
          },
          "cloudProvider": {
            "operator": "IN",
            "cloudProviders": [
              "AWS"
            ]
          },
          "accountId": {
            "operator": "IN",
            "accountIds": [
              "string"
            ]
          },
          "sourceRegion": {
            "operator": "IN",
            "regions": [
              "string"
            ]
          },
          "vpc": {
            "operator": "IN",
            "vpcs": [
              "string"
            ]
          },
          "subnets": {
            "operator": "CONTAINS_ANY_OF",
            "subnets": [
              "string"
            ]
          },
          "resourceGroupName": {
            "operator": "IN",
            "resourceGroupNames": [
              "string"
            ]
          },
          "resourceName": {
            "operator": "CONTAINS",
            "resourceNames": [
              "string"
            ]
          },
          "resourceId": {
            "operator": "IN",
            "resourceIds": [
              "string"
            ]
          },
          "tagKeys": {
            "operator": "CONTAINS_ANY_OF",
            "tagKeys": [
              "string"
            ]
          },
          "tagKeyValues": {
            "operator": "CONTAINS_ANY_OF",
            "tagKeyValues": [
              {
                "key": "string",
                "value": "string"
              }
            ]
          },
          "sourceAccountTagKeys": {
            "operator": "CONTAINS_ANY_OF",
            "sourceAccountTagKeys": [
              "string"
            ]
          },
          "sourceAccountTagKeyValues": {
            "operator": "CONTAINS_ANY_OF",
            "sourceAccountTagKeyValues": [
              {
                "key": "string",
                "value": "string"
              }
            ]
          },
          "globalClusterIdentifier": {
            "operator": "IN",
            "globalClusterIdentifier": [
              "string"
            ]
          }
        },
        "resourceInclusionOverride": [
          "cluster-3RYR75ARQOPQJ6MCRKTQFDR2GE",
          "db-FE4MOD3UCIYIQKXF3UVTCB55FA"
        ],
        "resourceExclusionOverride": [
          "i-0b0f5b5ef75b1c009",
          "43d9cc0b-b633-5431-93d0-38aa70a13745"
        ]
      },
      "backupPlan": {
        "backupPolicyType": "STANDARD",
        "standardPlan": {
          "backupSchedules": [
            {
              "vaultId": "0b8d140a-f4fe-58bf-afd7-a57f073d72c5",
              "scheduleConfig": {
                "frequency": "WEEKLY",
                "intervalConfig": {
                  "intervalHours": 8
                },
                "dailyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "weeklyConfig": {
                  "daysOfWeek": [
                    "MON",
                    "THU"
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "monthlyConfig": {
                  "daysOfMonth": [
                    5,
                    10,
                    15
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "annuallyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "timeOfYear": {
                    "month": 5,
                    "dayOfMonth": 14
                  },
                  "startWindowMinutes": 240
                }
              },
              "backupRetentionDays": 30
            }
          ],
          "scheduleTimezone": "UTC"
        },
        "highFrequencyPlan": {
          "resourceTypes": [
            {
              "resourceType": "AWS_S3"
            }
          ],
          "backupSchedules": [
            {
              "vaultId": "0b8d140a-f4fe-58bf-afd7-a57f073d72c5",
              "scheduleConfig": {
                "frequency": "WEEKLY",
                "intervalConfig": {
                  "intervalMinutes": 360
                },
                "dailyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "weeklyConfig": {
                  "daysOfWeek": [
                    "MON",
                    "THU"
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "monthlyConfig": {
                  "daysOfMonth": [
                    5,
                    10,
                    15
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "annuallyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "timeOfYear": {
                    "month": 5,
                    "dayOfMonth": 14
                  },
                  "startWindowMinutes": 240
                }
              },
              "backupRetentionDays": 30
            }
          ],
          "scheduleTimezone": "UTC"
        },
        "awsNativePitrPlan": {
          "retentionDays": 7,
          "resourceType": {
            "resourceType": "AWS_RDS"
          }
        },
        "awsNativeStandardPlan": {
          "backupSchedules": [
            {
              "targetRegion": "us-east-1",
              "scheduleConfig": {
                "frequency": "WEEKLY",
                "intervalConfig": {
                  "intervalHours": 4
                },
                "dailyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "weeklyConfig": {
                  "daysOfWeek": [
                    "MON",
                    "THU"
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "monthlyConfig": {
                  "daysOfMonth": [
                    5,
                    10,
                    15
                  ],
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "startWindowMinutes": 240
                },
                "annuallyConfig": {
                  "timeOfDay": {
                    "hour": 12,
                    "minute": 30
                  },
                  "timeOfYear": {
                    "month": 5,
                    "dayOfMonth": 14
                  },
                  "startWindowMinutes": 240
                }
              },
              "backupRetentionDays": 30
            }
          ],
          "vaultProtectionMode": "NONE"
        }
      }
    }
  ],
  "nextToken": "Y2NiMGYyZmMtYjYyZi00OTc5LTgzNjQtYmQ2YjEyYzdjZTNifDE=",
  "totalCount": 2347
}

Retrieves a list of backup policies in the specified project.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

ID of the project whose backup policies you want to retrieve. You can get your project ID from the API Credentials page in your global management console.

Query parameters

pageTokenstringOptional

Cursor that points to the first record of the next page of results. Get this value from the previous response. To preserve the results in the same order, use the same sorting and filters in the first request as all subsequent requests.

pageSizeintegerOptional>=1Defaults to 50

Maximum number of items to return in the response.

Response

Backup policies retrieved.

backupPolicieslist of objectsOptional

nextTokenstringOptional

Cursor that points to the first record of the next page of results. Pass this value in the next request.

totalCountintegerOptional

Total number of backup jobs that matched the filter options.