Get all connector sync jobs
Beta
Get information about all stored connector sync jobs listed by their creation date in ascending order.
Query parameters
-
from
number Starting offset (default: 0)
-
size
number Specifies a max number of results to get
-
status
string A sync job status to fetch connector sync jobs for
Values are
canceling
,canceled
,completed
,error
,in_progress
,pending
, orsuspended
. -
connector_id
string A connector id to fetch connector sync jobs for
-
job_type
string | array[string] A comma-separated list of job types to fetch the sync jobs for
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
count
number Required -
results
array[object] Required Hide results attributes Show results attributes object
cancelation_requested_at
string | number A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of: Time unit for milliseconds
canceled_at
string | number A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of: Time unit for milliseconds
completed_at
string | number A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of: Time unit for milliseconds
-
connector
object Required Additional properties are allowed.
Hide connector attributes Show connector attributes object
-
configuration
object Required Hide configuration attribute Show configuration attribute object
-
*
object Additional properties Additional properties are allowed.
Hide * attributes Show * attributes object
-
category
string -
depends_on
array[object] Required -
display
string Required Values are
textbox
,textarea
,numeric
,toggle
, ordropdown
. -
label
string Required -
options
array[object] Required -
order
number -
placeholder
string -
required
boolean Required -
sensitive
boolean Required -
type
string Values are
str
,int
,list
, orbool
. -
ui_restrictions
array[string] -
validations
array[object] -
value
object Required Additional properties are allowed.
-
-
-
filtering
object Required Additional properties are allowed.
Hide filtering attributes Show filtering attributes object
-
advanced_snippet
object Required Additional properties are allowed.
Hide advanced_snippet attributes Show advanced_snippet attributes object
-
value
object Required Additional properties are allowed.
-
rules
array[object] Required Additional properties are allowed.
-
validation
object Required Additional properties are allowed.
-
-
id
string Required -
index_name
string Required -
language
string -
pipeline
object Additional properties are allowed.
Hide pipeline attributes Show pipeline attributes object
-
extract_binary_content
boolean Required -
name
string Required -
reduce_whitespace
boolean Required -
run_ml_inference
boolean Required
-
-
service_type
string Required -
sync_cursor
object Additional properties are allowed.
-
created_at
string | number Required A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of: Time unit for milliseconds
-
deleted_document_count
number Required -
error
string -
id
string Required -
indexed_document_count
number Required -
indexed_document_volume
number Required -
job_type
string Required Values are
full
,incremental
, oraccess_control
. -
metadata
object Required Hide metadata attribute Show metadata attribute object
-
*
object Additional properties Additional properties are allowed.
-
started_at
string | number A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
One of: Time unit for milliseconds
-
status
string Required Values are
canceling
,canceled
,completed
,error
,in_progress
,pending
, orsuspended
. -
total_document_count
number Required -
trigger_method
string Required Values are
on_demand
orscheduled
. -
worker_hostname
string
-
curl \
--request GET http://api.example.com/_connector/_sync_job \
--header "Authorization: $API_KEY"