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: statusPossible values:

sort_orderstring · enumOptional

Sort order (asc or desc)

Default: descPossible values:

Responses

200

Policy list

application/json

get

/backup-and-dr/policies

HTTPcURLJavaScriptPython

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"
      },
      "status": "Active",
      "snapshots_count": 1,
      "last_backup_snapshot_id": "text",
      "last_backup_time": "2026-02-10T17:32:14.948Z",
      "last_backup_status": "text",
      "next_backup_time": "2026-02-10T17:32:14.948Z",
      "created_at": "2026-02-10T17:32:14.948Z",
      "updated_at": "2026-02-10T17:32:14.948Z"
    }
  ],
  "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

application/json

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

backup_on_savebooleanOptional

If true, triggers a backup immediately upon policy creation

Default: false

Responses

201

Policy created

application/json

post

/backup-and-dr/policies

HTTPcURLJavaScriptPython

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

{
  "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"
  },
  "backup_on_save": false
}

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"
  },
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-02-10T17:32:14.948Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-02-10T17:32:14.948Z",
  "created_at": "2026-02-10T17:32:14.948Z",
  "updated_at": "2026-02-10T17:32:14.948Z"
}

Search Policies

Search backup policies with filters

post

Advanced search endpoint for querying policies with multiple filters

Body

application/json

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

HTTPcURLJavaScriptPython

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

{
  "query": {
    "filters": [
      {
        "key": "status",
        "values": [
          "text"
        ]
      }
    ],
    "scopes": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "search": "text",
    "sort_by": "status",
    "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"
      },
      "status": "Active",
      "snapshots_count": 1,
      "last_backup_snapshot_id": "text",
      "last_backup_time": "2026-02-10T17:32:14.948Z",
      "last_backup_status": "text",
      "next_backup_time": "2026-02-10T17:32:14.948Z",
      "created_at": "2026-02-10T17:32:14.948Z",
      "updated_at": "2026-02-10T17:32:14.948Z"
    }
  ],
  "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

get

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

HTTPcURLJavaScriptPython

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"
  },
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-02-10T17:32:14.948Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-02-10T17:32:14.948Z",
  "created_at": "2026-02-10T17:32:14.948Z",
  "updated_at": "2026-02-10T17:32:14.948Z"
}

Update Policy

Update policy

put

Path parameters

policy_idstring · uuidRequired

Body

application/json

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.

backup_on_savebooleanOptional

If true, triggers a backup immediately upon policy update

Responses

200

Policy updated

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "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"
  },
  "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"
  },
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-02-10T17:32:14.948Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-02-10T17:32:14.948Z",
  "created_at": "2026-02-10T17:32:14.948Z",
  "updated_at": "2026-02-10T17:32:14.948Z"
}

Delete Policy

Delete policy

delete

Path parameters

policy_idstring · uuidRequired

Query parameters

cascadebooleanOptionalDefault: false

Responses

204

Policy deleted

delete

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

HTTPcURLJavaScriptPython

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

application/json

statusstring · enumRequiredPossible values:

Responses

200

Status updated

application/json

patch

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

HTTPcURLJavaScriptPython

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"
  },
  "status": "Active",
  "snapshots_count": 1,
  "last_backup_snapshot_id": "text",
  "last_backup_time": "2026-02-10T17:32:14.948Z",
  "last_backup_status": "text",
  "next_backup_time": "2026-02-10T17:32:14.948Z",
  "created_at": "2026-02-10T17:32:14.948Z",
  "updated_at": "2026-02-10T17:32:14.948Z"
}

Trigger On-Demand Backup

Trigger on-demand backup

post

Path parameters

policy_idstring · uuidRequired

Body

application/json

reasonstringOptional

notifybooleanOptionalDefault: true

Responses

202

Backup initiated

application/json

post

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

HTTPcURLJavaScriptPython

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"
}

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

application/json

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

400

Invalid request

500

Internal server error

post

/backup-and-dr/policies/preview

HTTPcURLJavaScriptPython

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",
  "data": [
    {
      "asset_type": "text",
      "asset_name": "text",
      "region": "text",
      "created_at": "2026-02-10T17:32:14.948Z",
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "query_filters": {
    "account_id": "text",
    "integration_id": "text",
    "region": "text",
    "scope": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "source_fields": [
      "text"
    ],
    "frns": [
      "text"
    ],
    "offset": 0,
    "size": 25
  }
}

Get Preview Resources

Get paginated preview resources

get

Retrieve a paginated list of preview resources by integration_id and preview_id.

Path parameters

integration_idstringRequired

Integration ID

preview_idstringRequired

Preview ID returned from preview request

Query parameters

pageinteger · min: 1OptionalDefault: 1

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

Responses

200

Preview resources page

application/json

400

Invalid request

404

Preview not found

500

Internal server error

get

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

HTTPcURLJavaScriptPython

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

{
  "preview_id": "text",
  "integration_id": "text",
  "data": [
    {
      "asset_type": "text",
      "asset_name": "text",
      "region": "text",
      "created_at": "2026-02-10T17:32:14.948Z",
      "discovery_type": "scope",
      "parent_frn": "text"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "total": 1,
    "has_next": true,
    "has_prev": true
  },
  "query_filters": {
    "account_id": "text",
    "integration_id": "text",
    "region": "text",
    "scope": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "source_fields": [
      "text"
    ],
    "frns": [
      "text"
    ],
    "offset": 0,
    "size": 25
  }
}

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: statusPossible values:

sort_orderstring · enumOptional

Sort order (asc or desc)

Default: descPossible values:

Responses

200

Snapshot list

application/json

get

/backup-and-dr/snapshots

HTTPcURLJavaScriptPython

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-02-10T17:32:14.948Z",
      "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-02-10T17:32:14.948Z",
      "asset_types": [
        "text"
      ],
      "changed_atrs": [
        {
          "integration_id": "text",
          "asset_type": "text",
          "regions": [
            "text"
          ]
        }
      ]
    }
  ],
  "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

application/json

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

HTTPcURLJavaScriptPython

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

{
  "query": {
    "filters": [
      {
        "key": "policy_id",
        "values": [
          "text"
        ]
      }
    ],
    "scopes": [
      {
        "type": "tags",
        "value": [
          "text"
        ]
      }
    ],
    "from_date": "2026-02-10T17:32:14.948Z",
    "to_date": "2026-02-10T17:32:14.948Z",
    "sort_by": "status",
    "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-02-10T17:32:14.948Z",
      "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-02-10T17:32:14.948Z",
      "asset_types": [
        "text"
      ],
      "changed_atrs": [
        {
          "integration_id": "text",
          "asset_type": "text",
          "regions": [
            "text"
          ]
        }
      ]
    }
  ],
  "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

get

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

HTTPcURLJavaScriptPython

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-02-10T17:32:14.948Z",
  "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-02-10T17:32:14.948Z",
  "asset_types": [
    "text"
  ],
  "changed_atrs": [
    {
      "integration_id": "text",
      "asset_type": "text",
      "regions": [
        "text"
      ]
    }
  ]
}

Delete Snapshot

Delete snapshot

delete

Path parameters

snapshot_idstring · uuidRequired

Query parameters

forcebooleanOptionalDefault: false

Responses

204

Snapshot deleted

delete

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

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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-02-10T17:32:14.948Z",
      "resource_creation_date": "2026-02-10T17:32:14.948Z",
      "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-02-10T17:32:14.948Z",
      "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

application/json

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

HTTPcURLJavaScriptPython

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-02-10T17:32:14.948Z",
      "resource_creation_date": "2026-02-10T17:32:14.948Z",
      "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-02-10T17:32:14.948Z",
      "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 Restored Module

Get restored module for a snapshot

get

Path parameters

snapshot_idstring · uuidRequired

Responses

200

Restored module

application/json

404

Restored module not found

get

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

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
  "policy_id": "123e4567-e89b-12d3-a456-426614174000",
  "account_id": "text",
  "module": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "owner": "text",
  "created_at": "2026-02-10T17:32:14.948Z",
  "expires_at": "2026-02-10T17:32:14.948Z"
}

Create Restored Module

Create or update a restored module for a snapshot

post

Creates a new restored module or updates the existing one if it already exists for this snapshot

Path parameters

snapshot_idstring · uuidRequired

Body

application/json

ownerstringOptional

Creator of the restore name

Responses

200

Module created or updated

application/json

201

Module created

application/json

400

Invalid request

404

Snapshot or policy not found

post

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

HTTPcURLJavaScriptPython

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

{
  "module": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "owner": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
  "policy_id": "123e4567-e89b-12d3-a456-426614174000",
  "account_id": "text",
  "module": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "owner": "text",
  "created_at": "2026-02-10T17:32:14.948Z",
  "expires_at": "2026-02-10T17:32:14.948Z"
}

Delete Restored Module

Delete restored module for a snapshot

delete

Path parameters

snapshot_idstring · uuidRequired

Responses

204

Module deleted

404

Restored module not found

delete

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

HTTPcURLJavaScriptPython

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

No content

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

application/json

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

400

Invalid request

500

Internal server error

post

/backup-and-dr/resources/policies

HTTPcURLJavaScriptPython

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"
  ]
}