Create backfill

curl -X POST "https://api.sequinstream.com/api/sinks/kafka-ids/backfills" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "id": "e0c918bb-12a2-4810-94a3-387cd672a478",
  "state": "active",
  "inserted_at": "2025-04-09T04:06:23Z",
  "sink_consumer": "kafka-ids",
  "updated_at": "2025-04-09T04:06:23Z",
  "canceled_at": null,
  "completed_at": null,
  "rows_ingested_count": 0,
  "rows_initial_count": 0,
  "rows_processed_count": 0,
  "sort_column": "benchmark_records"
}

{
  "id": "<string>",
  "state": "<string>",
  "table": "<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>"
}

POST

sinks

{sink_id_or_name}

backfills

curl -X POST "https://api.sequinstream.com/api/sinks/kafka-ids/backfills" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "id": "e0c918bb-12a2-4810-94a3-387cd672a478",
  "state": "active",
  "inserted_at": "2025-04-09T04:06:23Z",
  "sink_consumer": "kafka-ids",
  "updated_at": "2025-04-09T04:06:23Z",
  "canceled_at": null,
  "completed_at": null,
  "rows_ingested_count": 0,
  "rows_initial_count": 0,
  "rows_processed_count": 0,
  "sort_column": "benchmark_records"
}

{
  "id": "<string>",
  "state": "<string>",
  "table": "<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>"
}

Creates a new backfill for a specific sink. The backfill will be created in the active state.

Request fields

string

required

The name or ID of the sink

string

The source table for the backfill in the format schema.table or table (schema defaults to public)Must specify this parameter if the sink is configured to stream changes from all tables in a schema.

Response fields

string

The unique identifier of the backfill

string

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

string

The name of the table that was backfilled

string

The timestamp when the backfill was created

string

The name of the sink consumer

string

The timestamp when the backfill was last updated

string

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

string

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

integer

The number of rows ingested by the backfill

integer

The initial number of rows to be processed

integer

The number of rows processed by the backfill

string

The column used for sorting the backfill data

curl -X POST "https://api.sequinstream.com/api/sinks/kafka-ids/backfills" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "id": "e0c918bb-12a2-4810-94a3-387cd672a478",
  "state": "active",
  "inserted_at": "2025-04-09T04:06:23Z",
  "sink_consumer": "kafka-ids",
  "updated_at": "2025-04-09T04:06:23Z",
  "canceled_at": null,
  "completed_at": null,
  "rows_ingested_count": 0,
  "rows_initial_count": 0,
  "rows_processed_count": 0,
  "sort_column": "benchmark_records"
}