Bulk Jobs

Change parameters for IDs that have not yet been admitted

Partially merges options into the encrypted bulk configuration. This is allowed while awaiting upload or while paused before input scanning completes. Already-admitted child jobs keep the parameters with which they were created. A pause may briefly finish its current admission slice; retry a 409 update after the coordinator releases that slice. Set callback_url to null to clear it.

patch/bulk-jobs/{bulkId}

Request

  • Base URL: https://api.flashdata.dev/v2
  • URL: https://api.flashdata.dev/v2/bulk-jobs/{bulkId}
  • Auth: one of:
    • API key in cookie __Host-fd_session and API key in header X-CSRF-Token
    • API key in header X-API-Key

Path parameters

bulkIdstring required

Request body

optionsobject

Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored.

callback_urlstring uri nullable

Replacement completion callback, or null to remove the callback.

Response

Updated bulk job state

Changes

No recorded changes to this operation across all 1 revision of this API.