---
title: "List backup policies"
method: GET
path: "/backup-and-dr/policies"
---

# List backup policies

`GET /backup-and-dr/policies`

## Query parameters

- `page` integer
- `page_size` integer
- `search` string
- `status` string[]
- `integration_id` string[]
- `region` string[]
- `provider_type` string[]
- `sort_by` 'status' | 'snapshots_count' | 'policy_name' | 'created_at' | 'last_backup_time'
- `sort_order` 'asc' | 'desc'

## Response `200`

Policy list

- PolicyListResponse
  - `data` Policy[]
    - `account_id` string
    - `policy_id` string
    - `policy_name` string
    - `description` string
    - `integration_id` string
    - `region` string
    - `provider_type` string — Provider type (e.g., "aws", "azure", "gcp")
    - `schedule` ScheduleConfig
      - `frequency` 'One-time' | 'Daily' | 'Weekly' | 'Monthly', required
      - `hour` integer
      - `minute` integer
      - `days_of_week` string[]
      - `monthly_schedule_type` 'specific_day' | 'specific_weekday' | 'last_day'
      - `day_of_month` integer
      - `weekday_ordinal` 'First' | 'Second' | 'Third' | 'Fourth' | 'Last'
      - `weekday_name` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday'
      - `cron_expression` string
    - `scope` ScopeConfig[] — Scope configuration array. At least one scope type must be provided (e.g., tags, resource_group, asset_types, exclude_asset_types, or selected_resources). Note: integration_id and region are stored as separate fields, not in this scope array.
      - `type` 'tags' | 'resource_group' | 'asset_types' | 'exclude_asset_types' | 'selected_resources', required — Scope type identifier (display name): - tags: Tag-based filtering (maps to Elasticsearch field: tagsList.keyword) - resource_group: Azure resource group filtering (maps to Elasticsearch field: providerGroupId.keyword) - asset_types: Asset type filtering (maps to Elasticsearch field: assetType.keyword) - exclude_asset_types: Exclude asset type filtering (maps to Elasticsearch field: assetType.keyword). When combined with asset_types, exclusions take precedence. - selected_resources: Specific resources by FRN (union with other scope filters)
      - `value` string[], required — Array of scope values: - tags: Tag strings in "key:value" format (e.g., "env:prod", "team:platform") - resource_group: Azure resource group names (e.g., "rg-prod", "rg-staging") - asset_types: Asset type names (e.g., "aws_instance", "aws_s3_bucket", "azurerm_compute_virtual_machine") - exclude_asset_types: Asset type names to exclude (e.g., "aws_instance", "aws_s3_bucket"). When combined with asset_types, exclusions take precedence. - selected_resources: FRN strings (e.g., "frn:aws:123:us-east-1:ec2:i-abc123")
    - `notificationId` string — Notification ID for sending notifications
    - `vcs` VCSConfig
      - `project_id` string
      - `vcs_integration_id` string
      - `repo_id` string
    - `restore_instructions` string — Optional free-text restore instructions used as contextual input during DR restore generation
    - `status` 'Active' | 'Inactive'
    - `snapshots_count` integer
    - `last_backup_snapshot_id` string
    - `last_backup_time` string, date-time
    - `last_backup_status` string
    - `next_backup_time` string, date-time
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `pagination` Pagination
    - `page` integer, required
    - `page_size` integer, required
    - `total` integer, required
    - `has_next` boolean, required
    - `has_prev` boolean, required
  - `facets` Facet[] — Available filter options with counts
    - `field` string, required — The name of the field (e.g., 'integration_id', 'region', 'status')
    - `size` integer, required — The total number of unique values for this field
    - `pagination` Pagination, required
      - `page` integer, required
      - `page_size` integer, required
      - `total` integer, required
      - `has_next` boolean, required
      - `has_prev` boolean, required
    - `values` FacetValue[], required — Array of available values with their occurrence counts
      - `value` string — The value of the facet (e.g., 'us-east-1', 'Active')
      - `count` integer — Number of items that match this value

---

[API](https://skmtc.net/firefly/apis/backup-dr-api.md) · [All operations](https://skmtc.net/firefly/apis/backup-dr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefly/backup-dr-api/revisions/ff4cd0352ad5/schema)
