Salesforce Docs Portal

Backup & Recover Next API

GET Get backups list

GET /backups

Operation ID: getBackups.

Get a list of all backups.

Servers for this operation: https://api.salesforce.com/platform/data-resilience/backup/v1 (URL required for backup endpoints.).

Parameters

  • pageNumber (query, integer) Page number of the results to display.
    Default: 1.
  • pageSize (query, integer) Number of records to display per page.
    Default: 100. Minimum: 1. Maximum: 1000.
  • sort (query, SortField) Field to sort on.
  • sortDir (query, SortDir) Sort direction.
  • fromTimestamp (query, integer (int64)) The earliest starting timestamp of the backups to include in the results.
  • toTimestamp (query, integer (int64)) The latest starting timestamp of the backups to include in the results.
  • state (query, string) Filter by execution state(s). Multiple states can be provided as comma-separated values (e.g., 'COMPLETE,FAILED').
  • triggerType (query, string) Filter by trigger type of the backup.
    Allowed values: SCHEDULED, ON_DEMAND.
  • fromEndTimestamp (query, integer (int64)) The earliest end timestamp of the backups to include in the results.
  • toEndTimestamp (query, integer (int64)) The latest end timestamp of the backups to include in the results.
  • initiatedBy (query, string) Only display backups initiated by the specified user ID.
  • minRecordsFailed (query, integer (int64)) Minimum number of records that failed (inclusive).
  • maxRecordsFailed (query, integer (int64)) Maximum number of records that failed (inclusive).
  • minRecordsAdded (query, integer (int64)) Minimum number of records added since the previous backup (inclusive).
  • maxRecordsAdded (query, integer (int64)) Maximum number of records added since the previous backup (inclusive).
  • minRecordsChanged (query, integer (int64)) Minimum number of records updated since the previous backup (inclusive).
  • maxRecordsChanged (query, integer (int64)) Maximum number of records updated since the previous backup (inclusive).
  • minRecordsRemoved (query, integer (int64)) Minimum number of records deleted since the previous backup (inclusive).
  • maxRecordsRemoved (query, integer (int64)) Maximum number of records deleted since the previous backup (inclusive).
  • minTotalRecords (query, integer (int64)) Minimum total number of records (changed + added + removed) (inclusive).
  • maxTotalRecords (query, integer (int64)) Maximum total number of records (changed + added + removed) (inclusive).
  • backupType (query, string) Filter by backup type(s). Multiple types can be provided as comma-separated values (e.g., 'FULL,DELTA'). Valid values are FULL (full backup) or DELTA (incremental backup).
  • type (query, string) Filter by type(s). Multiple types can be provided as comma-separated values (e.g., 'DATA_FULL,DATA_DELTA'). Valid values are DATA_FULL, DATA_DELTA, METADATA_FULL.
  • dataStatus (query, string) Filter by data status(es). Multiple statuses can be provided as comma-separated values (e.g., 'COMPLETED,FAILED'). Valid values are IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED, CANCELED.
  • fileStatus (query, string) Filter by file status(es). Multiple statuses can be provided as comma-separated values (e.g., 'COMPLETED,IN_PROGRESS'). Valid values are IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED, CANCELED.

Responses

  • 200 List of backups.

    Media type: application/json. Schema: BackupsResponse.

  • 400 Invalid request

    Media type: application/json. Schema: Error.

  • 401 Unauthorized

    Media type: application/json. Schema: Error.

  • 403 Forbidden

    Media type: application/json. Schema: Error.

  • 404 The specified resource was not found.

    Media type: application/json. Schema: Error.

  • 500 Internal Server Error

    Media type: application/json. Schema: Error.