Batches
Pause a Batch
Pause processing of an in-progress Batch. Only unstarted tasks will be paused.
POST
Authentication
Authentication
Every request sent to Scale’s API requires authentication. In short, your API Key is the Bearer token. See the Authentication section for more details.
Batch Status Requirement
You can only pause batches that are currently in_progress. Batches in other statuses (staging, completed, paused) cannot be paused.
Once paused, the batch status will change to paused and all unstarted tasks will be paused.
Required request parameters
You are expected to provide one of the following in the request body:
- Batch ID (
batch_id
) - Batch Name (
batch_name
)
Authorizations
Your API Key is the Bearer token. See the Authentication section to learn how to access your key.
Body
application/json
Response
200
application/json
Batch pause initiated successfully.
The response is of type object
.