Skip to main content
PUT
Pause execution batch

Authorizations

X-Asteroid-Agents-Api-Key
string
header
required

Path Parameters

batchId
string<uuid>
required

The unique identifier of the execution batch

Response

The request has succeeded.

Execution batch with status counts

agentId
string<uuid>
required

Agent ID this batch belongs to

awaitingCapacityCount
integer
required

Number of items awaiting capacity

cancelledCount
integer
required

Number of cancelled items

concurrencyGroupId
string<uuid>
required

Batches sharing a group share one concurrency budget rather than each getting its own. Equals the batch's own id for a one-off batch; a recurring batch carries the id of the schedule that produced it.

config
object
required

Batch configuration

createdAt
string<date-time>
required

Creation timestamp

failedCount
integer
required

Number of items that could not be triggered and will not be retried

id
string<uuid>
required

Unique identifier for the batch

name
string
required

Human-readable name for the batch

pendingCount
integer
required

Number of pending items

startAt
string<date-time>
required

When to start triggering executions

status
enum<string>
required

Current batch status

Available options:
pending,
running,
paused,
completed,
cancelled
totalCount
integer
required

Total number of items

triggeredCount
integer
required

Number of triggered items

updatedAt
string<date-time>
required

Last update timestamp