Skip to main content
POST
Download a bounded remote event batch from Console

Body

application/json
domain
string

Filter one sync domain

execute
boolean

Actually download and apply the batch; default is a dry-run that only shows the plan (exit 3)

limit
string

Max events in batch

project
string

Alias for --project-ref

projectId
string

Console project id

projectRef
string

Console project ref

scope
string

Sync scope (organization)

Response

Success — body conforms to the @Returns schema.

applied
number
required
cursor
string | null
required
downloaded
number
required
enqueued
number
required
failed
number
required
linked
boolean
required
skipped
number
required
status
enum<string>
required
Available options:
unlinked,
noop,
downloaded,
failed
errorCode
string