PATCH
/
sinks
/
{sink_id_or_name}
/
backfills
/
{backfill_id}
curl -X PATCH "https://api.sequinstream.com/api/sinks/kafka-ids/backfills/e0c918bb-12a2-4810-94a3-387cd672a478" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"state": "cancelled"}'
{
  "id": "<string>",
  "state": "<string>",
  "inserted_at": "<string>",
  "sink_consumer": "<string>",
  "updated_at": "<string>",
  "canceled_at": "<string>",
  "completed_at": "<string>",
  "rows_ingested_count": 123,
  "rows_initial_count": 123,
  "rows_processed_count": 123,
  "sort_column": "<string>"
}

Updates an existing backfill.

Request fields

sink_id_or_name
string
required

The name or ID of the sink

backfill_id
string
required

The ID of the backfill to update

state
string

The new state of the backfill (active, cancelled)

Response fields

id
string

The unique identifier of the backfill

state
string

The current state of the backfill (active, completed, cancelled)

inserted_at
string

The timestamp when the backfill was created

sink_consumer
string

The name of the sink consumer

updated_at
string

The timestamp when the backfill was last updated

canceled_at
string

The timestamp when the backfill was cancelled (null if not cancelled)

completed_at
string

The timestamp when the backfill was completed (null if not completed)

rows_ingested_count
integer

The number of rows ingested by the backfill

rows_initial_count
integer

The initial number of rows to be processed

rows_processed_count
integer

The number of rows processed by the backfill

sort_column
string

The column used for sorting the backfill data

curl -X PATCH "https://api.sequinstream.com/api/sinks/kafka-ids/backfills/e0c918bb-12a2-4810-94a3-387cd672a478" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"state": "cancelled"}'