Configure Bulk API Usage

Any job processes that include more than 2,000 records are good candidates for Bulk API 2.0 to successfully prepare, execute, and manage an asynchronous workflow using the Bulk framework . Administrators can enable Bulk API and configure its limitations as needed. The jobs will be executed using Bulk API.

About this task

When the Bulk API reaches its limit, we will automatically switch to using the SOAP API for backup. If the API usage of your organization exceeds the percentage of the API limit within a 24-hour period, jobs will be paused in the backend and will resume once there is sufficient API quota available.

Procedure

Complete the following steps to configure the Bulk API usage:

  1. Navigate to Settings > General.
  2. Click Bulk API Usage . All organizations that you manage are displayed in the panel.
  3. Turn on the toggle next to the organization you desired, and the Configure Bulk API usage panel appears.
  4. Enter a value in the Bulk API backup threshold field. When the number of records in a backup job or in the backup process exceeds this limit, Bulk API and Bulk API 2.0 will be used for the job. The default value is 2,000.
    Note: For restore or sandbox seeding jobs, the Bulk API will be used once it is enabled.
  5. Then configure the following settings:
    • Enable Bulk API – Turn on/off the toggle to define whether to use Bulk API for the job when the number of records in a job exceeds the limit you set.
      Once the Bulk API is enabled, configure the following settings:
      • Batch limit – Enter a percentage for the field. The maximum number of Bulk API batches that can be submitted per rolling 24-hour period is 15,000. If the usage of Bulk API in a backup exceeds the configured percentage of 15,000, IBM® Storage Protect for Cloud Salesforce will automatically switch to using Bulk API 2.0 (if enabled) and SOAP API for backup. The default value is 80%.
      • Define scope – The following options are provided:
        • Backup and archive – Enable Bulk API for backup and archive jobs.
        • Restore – Enable Bulk API for restore and sandbox seeding jobs. Note that the Bulk API is not supported when restoring metadata, fields, or archived data.
    • Enable Bulk API 2.0 for backup – Turn on/off the toggle to define whether to use Bulk API 2.0 for backup when the number of records in a backup job exceeds the limit you set.
      Once the Bulk API 2.0 is enabled, configure the following settings:
      • Limit on query job number per backup – Enter a percentage for the field. The maximum number of query jobs that can be submitted per 24-hour rolling window is 10,000. If the usage of Bulk API 2.0 in a backup exceeds the configured percentage of 10,000, IBM Storage Protect for Cloud Salesforce will automatically switch to using the SOAP API for backup. The default value is 80%.
      • Limit on query result size per backup – Enter a value for the field. The default value is 800 GB. The maximum size of query results that can be generated per 24 hour rolling window is 1000 GB. If the usage of Bulk API 2.0 in a backup exceeds the configured limit, IBM Storage Protect for Cloud Salesforce will automatically switch to using the SOAP API for backup.
  6. Click Save apply the settings.