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
GET /_connector/_sync_job
curl \
-X GET http://api.example.com/_connector/_sync_job
Response examples (200)
{
"count": 42.0,
"results": [
{
"": "string",
"connector": {
"configuration": {
"additionalProperty1": {
"category": "string",
"depends_on": [
{}
],
"display": "textbox",
"label": "string",
"options": [
{}
],
"order": 42.0,
"placeholder": "string",
"required": true,
"sensitive": true,
"type": "str",
"ui_restrictions": [
"string"
],
"validations": [
{}
],
"value": {}
},
"additionalProperty2": {
"category": "string",
"depends_on": [
{}
],
"display": "textbox",
"label": "string",
"options": [
{}
],
"order": 42.0,
"placeholder": "string",
"required": true,
"sensitive": true,
"type": "str",
"ui_restrictions": [
"string"
],
"validations": [
{}
],
"value": {}
}
},
"filtering": {
"advanced_snippet": {
"value": {}
},
"rules": [
{}
],
"validation": {
"errors": [
{}
],
"state": "edited"
}
},
"id": "string",
"index_name": "string",
"language": "string",
"pipeline": {
"extract_binary_content": true,
"name": "string",
"reduce_whitespace": true,
"run_ml_inference": true
},
"service_type": "string",
"sync_cursor": {}
},
"deleted_document_count": 42.0,
"error": "string",
"id": "string",
"indexed_document_count": 42.0,
"indexed_document_volume": 42.0,
"job_type": "full",
"metadata": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"status": "canceling",
"total_document_count": 42.0,
"trigger_method": "on_demand",
"worker_hostname": "string"
}
]
}