Backup & Disaster Recovery

The Backup and Disaster Recovery API allows you to manage backup policies, snapshots, and disaster recovery operations in Firefly.

Policies

List Policies

List backup policies

get

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

searchstringOptional

integration_idstring[]Optional

Filter by integration ID (supports multiple values)

regionstring[]Optional

Filter by region (supports multiple values)

provider_typestring[]Optional

Filter by provider type (supports multiple values)

sort_bystring · enumOptional

Field to sort by

Default: created_atPossible values:

sort_orderstring · enumOptional

Sort order (asc or desc)

Default: descPossible values:

Responses

200

Policy list

application/json

get/backup-and-dr/policies

GET /v2/backup-and-dr/policies HTTP/1.1
Host: api.firefly.ai
Accept: */*

200

Policy list

{
  "data": [
    {
      "account_id": "text",
      "policy_id": "text",
      "policy_name": "text",
      "description": "text",
      "integration_id": "text",
      "region": "text",
      "provider_type": "text",
      "schedule": {
        "frequency": "One-time",
        "hour": 1,
        "minute": 1,
        "days_of_week": [
          "Sunday"
        ],
        "monthly_schedule_type": "specific_day",
        "day_of_month": 1,
        "weekday_ordinal": "First",
        "weekday_name": "Sunday",
        "cron_expression": "text"
      },
      "scope": [
        {
          "type": "tags",
          "value": [
            "text"
          ]
        }
      ],
      "notificationId": "text",
      "vcs": {
        "project_id": "text",
        "vcs_integration_id": "text",
        "repo_id": "text"
      },
      "restore_instructions": "text",
      "status": "Active",
      "snapshots_count": 1,
      "last_backup_snapshot_id": "text",
      "last_backup_time": "2026-01-01T00:00:00.000Z",
      "last_backup_status": "text",
      "next_backup_time": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Create Policy

Create backup policy

post

Body

policy_namestring · max: 100Required

descriptionstring · max: 500Optional

integration_idstringRequired

Single integration ID

regionstringRequired

Single AWS region (e.g., us-east-1)

provider_typestring · max: 50Required

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstringOptional

Notification ID for sending notifications

restore_instructionsstring · max: 2000Optional

Optional free-text restore instructions used as contextual input during DR restore generation

backup_on_savebooleanOptional

If true, triggers a backup immediately upon policy creation

Default: true

Responses

201

Policy created

application/json

account_idstringOptional

policy_idstringOptional

policy_namestringOptional

descriptionstringOptional

integration_idstringOptional

regionstringOptional

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstringOptional

Notification ID for sending notifications

restore_instructionsstringOptional

Optional free-text restore instructions used as contextual input during DR restore generation

statusstring · enumOptionalPossible values:

snapshots_countintegerOptional

last_backup_snapshot_idstringOptional

last_backup_timestring · date-timeOptional

last_backup_statusstringOptional

next_backup_timestring · date-timeOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

post/backup-and-dr/policies

POST /v2/backup-and-dr/policies HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 511

{
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "backup_on_save": true
}

201

Policy created

{
  "account_id": "text",
  "policy_id": "text",
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-01-01T00:00:00.000Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Search Policies

Search backup policies with filters

post

Advanced search endpoint for querying policies with multiple filters

Body

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

facet_pageinteger · min: 1Optional

Page number for facet values pagination

Default: 1

facet_page_sizeinteger · min: 1 · max: 200Optional

Page size for facet values pagination

Default: 50

facet_fieldsstring[]Optional

Specific facet fields to return (empty = all available facets)

Responses

200

Policy list

application/json

post/backup-and-dr/policies/search

POST /v2/backup-and-dr/policies/search HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "query": {
    "filters": [
      {
        "key": "status",
        "values": [
          "text"
        ]
      }
    ],
    "scopes": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "search": "text",
    "sort_by": "created_at",
    "sort_order": "desc"
  },
  "page": 1,
  "page_size": 25,
  "facet_page": 1,
  "facet_page_size": 50,
  "facet_fields": [
    "text"
  ]
}

200

Policy list

{
  "data": [
    {
      "account_id": "text",
      "policy_id": "text",
      "policy_name": "text",
      "description": "text",
      "integration_id": "text",
      "region": "text",
      "provider_type": "text",
      "schedule": {
        "frequency": "One-time",
        "hour": 1,
        "minute": 1,
        "days_of_week": [
          "Sunday"
        ],
        "monthly_schedule_type": "specific_day",
        "day_of_month": 1,
        "weekday_ordinal": "First",
        "weekday_name": "Sunday",
        "cron_expression": "text"
      },
      "scope": [
        {
          "type": "tags",
          "value": [
            "text"
          ]
        }
      ],
      "notificationId": "text",
      "vcs": {
        "project_id": "text",
        "vcs_integration_id": "text",
        "repo_id": "text"
      },
      "restore_instructions": "text",
      "status": "Active",
      "snapshots_count": 1,
      "last_backup_snapshot_id": "text",
      "last_backup_time": "2026-01-01T00:00:00.000Z",
      "last_backup_status": "text",
      "next_backup_time": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Get Policy

Get policy details

get

Path parameters

policy_idstring · uuidRequired

Responses

200

Policy details

application/json

account_idstringOptional

policy_idstringOptional

policy_namestringOptional

descriptionstringOptional

integration_idstringOptional

regionstringOptional

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstringOptional

Notification ID for sending notifications

restore_instructionsstringOptional

Optional free-text restore instructions used as contextual input during DR restore generation

statusstring · enumOptionalPossible values:

snapshots_countintegerOptional

last_backup_snapshot_idstringOptional

last_backup_timestring · date-timeOptional

last_backup_statusstringOptional

next_backup_timestring · date-timeOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

get/backup-and-dr/policies/{policy_id}

GET /v2/backup-and-dr/policies/{policy_id} HTTP/1.1
Host: api.firefly.ai
Accept: */*

200

Policy details

{
  "account_id": "text",
  "policy_id": "text",
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-01-01T00:00:00.000Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update Policy

Update policy

put

Path parameters

policy_idstring · uuidRequired

Body

policy_namestring · max: 100Optional

descriptionstring · max: 500Optional

integration_idstringOptional

regionstringOptional

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstring · nullableOptional

Notification ID for sending notifications. Omit or set to null to keep existing, set to empty string to remove, or provide a value to update.

restore_instructionsstring · max: 2000Optional

Optional free-text restore instructions used as contextual input during DR restore generation

backup_on_savebooleanOptional

If true, triggers a backup immediately after policy update. Defaults to true.

Default: true

Responses

200

Policy updated

application/json

account_idstringOptional

policy_idstringOptional

policy_namestringOptional

descriptionstringOptional

integration_idstringOptional

regionstringOptional

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstringOptional

Notification ID for sending notifications

restore_instructionsstringOptional

Optional free-text restore instructions used as contextual input during DR restore generation

statusstring · enumOptionalPossible values:

snapshots_countintegerOptional

last_backup_snapshot_idstringOptional

last_backup_timestring · date-timeOptional

last_backup_statusstringOptional

next_backup_timestring · date-timeOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

put/backup-and-dr/policies/{policy_id}

PUT /v2/backup-and-dr/policies/{policy_id} HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 511

{
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "backup_on_save": true
}

200

Policy updated

{
  "account_id": "text",
  "policy_id": "text",
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-01-01T00:00:00.000Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete Policy

Delete policy

delete

Path parameters

policy_idstring · uuidRequired

Query parameters

cascadebooleanOptionalDefault: false

Responses

204

Policy deleted

No content

delete/backup-and-dr/policies/{policy_id}

DELETE /v2/backup-and-dr/policies/{policy_id} HTTP/1.1
Host: api.firefly.ai
Accept: */*

204

Policy deleted

No content

Toggle Policy Status

Toggle policy status

patch

Path parameters

policy_idstring · uuidRequired

Body

statusstring · enumRequiredPossible values:

Responses

200

Status updated

application/json

account_idstringOptional

policy_idstringOptional

policy_namestringOptional

descriptionstringOptional

integration_idstringOptional

regionstringOptional

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

notificationIdstringOptional

Notification ID for sending notifications

restore_instructionsstringOptional

Optional free-text restore instructions used as contextual input during DR restore generation

statusstring · enumOptionalPossible values:

snapshots_countintegerOptional

last_backup_snapshot_idstringOptional

last_backup_timestring · date-timeOptional

last_backup_statusstringOptional

next_backup_timestring · date-timeOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

patch/backup-and-dr/policies/{policy_id}/status

PATCH /v2/backup-and-dr/policies/{policy_id}/status HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "Active"
}

200

Status updated

{
  "account_id": "text",
  "policy_id": "text",
  "policy_name": "text",
  "description": "text",
  "integration_id": "text",
  "region": "text",
  "provider_type": "text",
  "schedule": {
    "frequency": "One-time",
    "hour": 1,
    "minute": 1,
    "days_of_week": [
      "Sunday"
    ],
    "monthly_schedule_type": "specific_day",
    "day_of_month": 1,
    "weekday_ordinal": "First",
    "weekday_name": "Sunday",
    "cron_expression": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "notificationId": "text",
  "vcs": {
    "project_id": "text",
    "vcs_integration_id": "text",
    "repo_id": "text"
  },
  "restore_instructions": "text",
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-01-01T00:00:00.000Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Trigger On-Demand Backup

Trigger on-demand backup

post

Path parameters

policy_idstring · uuidRequired

Body

reasonstringOptional

notifybooleanOptionalDefault: true

Responses

202

Backup initiated

application/json

snapshot_idstring · uuidOptional

job_idstring · uuidOptional

statusstringOptional

post/backup-and-dr/policies/{policy_id}/trigger

POST /v2/backup-and-dr/policies/{policy_id}/trigger HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "reason": "text",
  "notify": true
}

202

Backup initiated

{
  "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text"
}

Assign Resources to Policy

Add resources to a policy

patch

Appends FRNs to the policy's selected_resources scope. Duplicate FRNs are automatically deduplicated. Automatically triggers an immediate backup after adding resources.

Path parameters

policy_idstring · uuidRequired

Body

frnsstring[] · min: 1Required

FRN strings to add to the policy (duplicates are automatically deduplicated)

Responses

200

Resources added successfully and backup initiated

application/json

messagestringOptional

Success message

snapshot_idstring · uuidOptional

ID of the triggered snapshot

snapshot_statusstringOptional

Initial status of the snapshot

400

Invalid request (empty FRNs, inactive policy)

404

Policy not found

patch/backup-and-dr/policies/{policy_id}/resources

PATCH /v2/backup-and-dr/policies/{policy_id}/resources HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "frns": [
    "text"
  ]
}

{
  "message": "text",
  "policy": {
    "account_id": "text",
    "policy_id": "text",
    "policy_name": "text",
    "description": "text",
    "integration_id": "text",
    "region": "text",
    "provider_type": "text",
    "schedule": {
      "frequency": "One-time",
      "hour": 1,
      "minute": 1,
      "days_of_week": [
        "Sunday"
      ],
      "monthly_schedule_type": "specific_day",
      "day_of_month": 1,
      "weekday_ordinal": "First",
      "weekday_name": "Sunday",
      "cron_expression": "text"
    },
    "scope": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "notificationId": "text",
    "vcs": {
      "project_id": "text",
      "vcs_integration_id": "text",
      "repo_id": "text"
    },
    "restore_instructions": "text",
    "status": "Active",
    "snapshots_count": 1,
    "last_backup_snapshot_id": "text",
    "last_backup_time": "2026-01-01T00:00:00.000Z",
    "last_backup_status": "text",
    "next_backup_time": "2026-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  },
  "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
  "snapshot_status": "text"
}

Preview Affected Resources

Preview affected resources

post

Initiate preview discovery and return preview_id with total count. Preview ID is calculated server-side from region and scope configuration. Use GET endpoint to retrieve paginated resources.

Body

integration_idstringRequired

Integration ID to filter resources

regionstringRequired

AWS region (e.g., us-east-1)

policy_idstringOptional

Optional policy ID for snapshot workflows (enables isolation per policy). If omitted, treated as preview request with caching.

Responses

200

Preview initiated with preview_id and total count. Use GET endpoint to retrieve paginated resources.

application/json

preview_idstringRequired

Unique preview identifier for retrieving resources

integration_idstringRequired

Integration ID

total_countintegerRequired

Total number of discovered resources

400

Invalid request

500

Internal server error

post/backup-and-dr/policies/preview

POST /v2/backup-and-dr/policies/preview HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "integration_id": "text",
  "region": "text",
  "scopes": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "policy_id": "text"
}

{
  "preview_id": "text",
  "integration_id": "text",
  "total_count": 1
}

List Preview Resources

List paginated preview resources

get

Retrieve a paginated list of preview resources by preview_id.

Path parameters

preview_idstringRequired

Preview ID returned from preview request

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 5000OptionalDefault: 25

Responses

200

Preview resources page

application/json

preview_idstringRequired

Unique preview identifier for pagination

400

Invalid request

404

Preview not found

500

Internal server error

get/backup-and-dr/policies/preview/{preview_id}

GET /v2/backup-and-dr/policies/preview/{preview_id} HTTP/1.1
Host: api.firefly.ai
Accept: */*

{
  "preview_id": "text",
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "data": [
    {
      "frn": "text",
      "asset_type": "text",
      "asset_name": "text",
      "region": "text",
      "provider": "text",
      "service": "text",
      "tags_list": [
        "text"
      ],
      "created_at": "2026-01-01T00:00:00.000Z",
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "query_filters": {
    "account_id": "text",
    "integration_id": "text",
    "region": "text",
    "scope": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "source_fields": [
      "text"
    ],
    "frns": [
      "text"
    ],
    "offset": 0,
    "size": 25
  }
}

Search Preview Resources

Search preview resources with filters

post

Advanced search endpoint for querying preview resources with multiple filters and facets

Path parameters

preview_idstringRequired

Preview ID returned from preview request

Body

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

facet_pageinteger · min: 1Optional

Page number for facet values pagination

Default: 1

facet_page_sizeinteger · min: 1 · max: 200Optional

Page size for facet values pagination

Default: 50

facet_fieldsstring[]Optional

Specific facet fields to return

Responses

200

Preview resources search results

application/json

400

Invalid request

404

Preview not found

500

Internal server error

post/backup-and-dr/policies/preview/{preview_id}/search

POST /v2/backup-and-dr/policies/preview/{preview_id}/search HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "query": {
    "filters": [
      {
        "key": "asset_type",
        "values": [
          "text"
        ]
      }
    ],
    "search": "text"
  },
  "page": 1,
  "page_size": 25,
  "facet_page": 1,
  "facet_page_size": 50,
  "facet_fields": [
    "text"
  ]
}

{
  "data": [
    {
      "frn": "text",
      "asset_type": "text",
      "asset_name": "text",
      "region": "text",
      "provider": "text",
      "service": "text",
      "tags_list": [
        "text"
      ],
      "created_at": "2026-01-01T00:00:00.000Z",
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Snapshots

List Snapshots

List snapshots

get

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

policy_idstring · uuid[]Optional

Filter by policy ID (supports multiple values)

integration_idstring[]Optional

Filter by integration ID (supports multiple values)

regionstring[]Optional

Filter by region (supports multiple values)

from_datestring · date-timeOptional

Filter snapshots from this date

to_datestring · date-timeOptional

Filter snapshots until this date

sort_bystring · enumOptional

Field to sort by

Default: snapshot_timePossible values:

sort_orderstring · enumOptional

Sort order (asc or desc)

Default: descPossible values:

Responses

200

Snapshot list

application/json

get/backup-and-dr/snapshots

GET /v2/backup-and-dr/snapshots HTTP/1.1
Host: api.firefly.ai
Accept: */*

200

Snapshot list

{
  "data": [
    {
      "account_id": "text",
      "snapshot_id": "text",
      "snapshot_time": "2026-01-01T00:00:00.000Z",
      "policy_id": "text",
      "provider_type": "text",
      "integration_id": "text",
      "region": "text",
      "trigger": {
        "type": "scheduled",
        "initiated_by": "text"
      },
      "scope": [
        {
          "type": "tags",
          "value": [
            "text"
          ]
        }
      ],
      "status": "Pending",
      "is_latest": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "asset_types": [
        "text"
      ],
      "changed_atrs": [
        {
          "integration_id": "text",
          "asset_type": "text",
          "regions": [
            "text"
          ]
        }
      ],
      "error_code": "SCOPE_EMPTY"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "summary": {
    "total_snapshots": 1,
    "successful_snapshots": 1,
    "failed_snapshots": 1,
    "in_progress_snapshots": 1
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Search Snapshots

Search snapshots with filters

post

Advanced search endpoint for querying snapshots with multiple filters

Body

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

facet_pageinteger · min: 1Optional

Page number for facet values pagination

Default: 1

facet_page_sizeinteger · min: 1 · max: 200Optional

Page size for facet values pagination

Default: 50

facet_fieldsstring[]Optional

Specific facet fields to return (empty = all available facets)

Responses

200

Snapshot list

application/json

post/backup-and-dr/snapshots/search

POST /v2/backup-and-dr/snapshots/search HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "query": {
    "filters": [
      {
        "key": "policy_id",
        "values": [
          "text"
        ]
      }
    ],
    "scopes": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "from_date": "2026-01-01T00:00:00.000Z",
    "to_date": "2026-01-01T00:00:00.000Z",
    "sort_by": "snapshot_time",
    "sort_order": "desc"
  },
  "page": 1,
  "page_size": 25,
  "facet_page": 1,
  "facet_page_size": 50,
  "facet_fields": [
    "text"
  ]
}

200

Snapshot list

{
  "data": [
    {
      "account_id": "text",
      "snapshot_id": "text",
      "snapshot_time": "2026-01-01T00:00:00.000Z",
      "policy_id": "text",
      "provider_type": "text",
      "integration_id": "text",
      "region": "text",
      "trigger": {
        "type": "scheduled",
        "initiated_by": "text"
      },
      "scope": [
        {
          "type": "tags",
          "value": [
            "text"
          ]
        }
      ],
      "status": "Pending",
      "is_latest": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "asset_types": [
        "text"
      ],
      "changed_atrs": [
        {
          "integration_id": "text",
          "asset_type": "text",
          "regions": [
            "text"
          ]
        }
      ],
      "error_code": "SCOPE_EMPTY"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "summary": {
    "total_snapshots": 1,
    "successful_snapshots": 1,
    "failed_snapshots": 1,
    "in_progress_snapshots": 1
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Get Snapshot

Get snapshot details

get

Path parameters

snapshot_idstring · uuidRequired

Responses

200

Snapshot details

application/json

account_idstringRequired

snapshot_idstringRequired

snapshot_timestring · date-timeOptional

policy_idstringRequired

provider_typestring · max: 50Optional

Provider type (e.g., "aws", "azure", "gcp")

integration_idstringOptional

Integration ID (stored as separate column, not in scope)

regionstringOptional

Region (stored as separate column, not in scope)

statusstring · enumOptionalPossible values:

is_latestbooleanOptional

Indicates if this is the latest snapshot for the policy

created_atstring · date-timeOptional

asset_typesstring[]Optional

List of distinct asset type names from snapshot resources (populated on read only)

error_codestring · enum · nullableOptional

Error code when status is Failed. Null for non-failed snapshots. SCOPE_EMPTY: no resources matched the policy scope. INTERNAL_ERROR: system failure, customer should retry or contact support.

Possible values:

get/backup-and-dr/snapshots/{snapshot_id}

GET /v2/backup-and-dr/snapshots/{snapshot_id} HTTP/1.1
Host: api.firefly.ai
Accept: */*

200

Snapshot details

{
  "account_id": "text",
  "snapshot_id": "text",
  "snapshot_time": "2026-01-01T00:00:00.000Z",
  "policy_id": "text",
  "provider_type": "text",
  "integration_id": "text",
  "region": "text",
  "trigger": {
    "type": "scheduled",
    "initiated_by": "text"
  },
  "scope": [
    {
      "type": "tags",
      "value": [
        "text"
      ]
    }
  ],
  "status": "Pending",
  "is_latest": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "asset_types": [
    "text"
  ],
  "changed_atrs": [
    {
      "integration_id": "text",
      "asset_type": "text",
      "regions": [
        "text"
      ]
    }
  ],
  "error_code": "SCOPE_EMPTY"
}

Delete Snapshot

Delete snapshot

delete

Path parameters

snapshot_idstring · uuidRequired

Query parameters

forcebooleanOptionalDefault: false

Responses

204

Snapshot deleted

No content

delete/backup-and-dr/snapshots/{snapshot_id}

DELETE /v2/backup-and-dr/snapshots/{snapshot_id} HTTP/1.1
Host: api.firefly.ai
Accept: */*

204

Snapshot deleted

No content

Get Snapshot Resources

Get snapshot resources

get

Path parameters

snapshot_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

searchstringOptional

asset_typestring[]Optional

Filter by resource type (supports multiple values)

regionstring[]Optional

Filter by region (supports multiple values)

Responses

200

Resource list

application/json

get/backup-and-dr/snapshots/{snapshot_id}/resources

GET /v2/backup-and-dr/snapshots/{snapshot_id}/resources HTTP/1.1
Host: api.firefly.ai
Accept: */*

200

Resource list

{
  "data": [
    {
      "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_id": "text",
      "integration_id": "text",
      "frn": "text",
      "resource_id": "text",
      "asset_id": "text",
      "arn": "text",
      "provider": "text",
      "service": "text",
      "asset_type": "text",
      "region": "text",
      "name": "text",
      "tf_object": "text",
      "console_url": "text",
      "account_name": "text",
      "provider_id": "text",
      "delete_command": "text",
      "inventory_update_time": "2026-01-01T00:00:00.000Z",
      "resource_creation_date": "2026-01-01T00:00:00.000Z",
      "first_seen": "text",
      "resource_status": "text",
      "tagging_status": "text",
      "provider_type": "text",
      "provider_sub_type": "text",
      "stack_id": "text",
      "stack_name": "text",
      "vcs_repo": "text",
      "vcs_provider": "text",
      "vcs_code_link": "text",
      "state": "text",
      "iac_type": "text",
      "prev_state": "text",
      "last_resource_state_change": "2026-01-01T00:00:00.000Z",
      "is_excluded": true,
      "is_locked": true,
      "is_out_of_sync": true,
      "is_event_driven": true,
      "ignored_drift": true,
      "drift": [],
      "tags": "text",
      "tags_list": [
        "text"
      ],
      "classifications": [
        "text"
      ],
      "monthly_cloud_cost_usd": 1,
      "monthly_state_cost_usd": 1,
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "summary": {
    "total_resources": 1,
    "by_type": {},
    "by_region": {}
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Search Snapshot Resources

Search snapshot resources with filters

post

Advanced search endpoint for querying snapshot resources with multiple filters

Path parameters

snapshot_idstring · uuidRequired

Body

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 25

facet_pageinteger · min: 1Optional

Page number for facet values pagination

Default: 1

facet_page_sizeinteger · min: 1 · max: 200Optional

Page size for facet values pagination

Default: 50

facet_fieldsstring[]Optional

Specific facet fields to return (empty = all available facets)

Responses

200

Resource list

application/json

post/backup-and-dr/snapshots/{snapshot_id}/resources/search

POST /v2/backup-and-dr/snapshots/{snapshot_id}/resources/search HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "query": {
    "filters": [
      {
        "key": "asset_type",
        "values": [
          "text"
        ]
      }
    ],
    "search": "text"
  },
  "page": 1,
  "page_size": 25,
  "facet_page": 1,
  "facet_page_size": 50,
  "facet_fields": [
    "text"
  ]
}

200

Resource list

{
  "data": [
    {
      "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_id": "text",
      "integration_id": "text",
      "frn": "text",
      "resource_id": "text",
      "asset_id": "text",
      "arn": "text",
      "provider": "text",
      "service": "text",
      "asset_type": "text",
      "region": "text",
      "name": "text",
      "tf_object": "text",
      "console_url": "text",
      "account_name": "text",
      "provider_id": "text",
      "delete_command": "text",
      "inventory_update_time": "2026-01-01T00:00:00.000Z",
      "resource_creation_date": "2026-01-01T00:00:00.000Z",
      "first_seen": "text",
      "resource_status": "text",
      "tagging_status": "text",
      "provider_type": "text",
      "provider_sub_type": "text",
      "stack_id": "text",
      "stack_name": "text",
      "vcs_repo": "text",
      "vcs_provider": "text",
      "vcs_code_link": "text",
      "state": "text",
      "iac_type": "text",
      "prev_state": "text",
      "last_resource_state_change": "2026-01-01T00:00:00.000Z",
      "is_excluded": true,
      "is_locked": true,
      "is_out_of_sync": true,
      "is_event_driven": true,
      "ignored_drift": true,
      "drift": [],
      "tags": "text",
      "tags_list": [
        "text"
      ],
      "classifications": [
        "text"
      ],
      "monthly_cloud_cost_usd": 1,
      "monthly_state_cost_usd": 1,
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "summary": {
    "total_resources": 1,
    "by_type": {},
    "by_region": {}
  },
  "facets": [
    {
      "field": "text",
      "size": 1,
      "pagination": {
        "page": 1,
        "page_size": 1,
        "total": 1,
        "has_next": true,
        "has_prev": true
      },
      "values": [
        {
          "value": "text",
          "count": 1
        }
      ]
    }
  ]
}

Get Restore Instructions

Get restore instructions for a snapshot

get

Returns the restore instructions from the policy associated with the given snapshot

Path parameters

snapshot_idstring · uuidRequired

Responses

200

Restore instructions

application/json

policy_idstringOptional

restore_instructionsstringOptional

404

Snapshot not found

get/backup-and-dr/snapshots/{snapshot_id}/restore-instructions

GET /v2/backup-and-dr/snapshots/{snapshot_id}/restore-instructions HTTP/1.1
Host: api.firefly.ai
Accept: */*

{
  "policy_id": "text",
  "restore_instructions": "text"
}

Get Snapshot Artifact

Get a presigned download URL for the snapshot restore artifact

get

Returns a presigned S3 URL for downloading the restore artifact archive (tar.gz) generated for the snapshot. The URL is short-lived, so download the archive promptly after requesting it.

Path parameters

snapshot_idstring · uuidRequired

Responses

200

Presigned download URL for the restore artifact

application/json

downloadUrlstring · uriRequired

Presigned S3 URL for downloading the restore archive

404

Restore artifact not found

get/backup-and-dr/snapshots/{snapshot_id}/artifact

GET /v2/backup-and-dr/snapshots/{snapshot_id}/artifact HTTP/1.1
Host: api.firefly.ai
Accept: */*

{
  "downloadUrl": "https://example.com"
}

Resources

Get Policies by FRNs

Get policy IDs that back up the given FRNs

post

Returns a mapping of FRNs to the list of policy IDs (application IDs) that back up each resource

Body

frnsstring[] · min: 1Required

Array of FRNs (Firefly Resource Names) to query

Example: ["arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0","arn:aws:s3:::my-bucket"]

Responses

200

Mapping of FRNs to policy IDs

application/json

Other propertiesstring · uuid[]Optional

400

Invalid request

500

Internal server error

post/backup-and-dr/resources/policies

POST /v2/backup-and-dr/resources/policies HTTP/1.1
Host: api.firefly.ai
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "frns": [
    "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0",
    "arn:aws:s3:::my-bucket"
  ]
}

{
  "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "arn:aws:s3:::my-bucket": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}