Query parameters
-
from number
Starting offset (default: 0)
-
size number
Specifies a max number of results to get
-
index_name string | array[string]
A comma-separated list of connector index names to fetch connector documents for
-
connector_name string | array[string]
A comma-separated list of connector names to fetch connector documents for
-
service_type string | array[string]
A comma-separated list of connector service types to fetch connector documents for
-
query string
A wildcard query string that filters connectors with matching name, description or index name
GET /_connector
curl \
-X GET http://api.example.com/_connector
Response examples (200)
{
"count": 42.0,
"results": [
{
"api_key_id": "string",
"api_key_secret_id": "string",
"configuration": {
"additionalProperty1": {
"category": "string",
"": 42.0,
"depends_on": [
{}
],
"display": "textbox",
"label": "string",
"options": [
{}
],
"order": 42.0,
"placeholder": "string",
"required": true,
"sensitive": true,
"tooltip": "string",
"type": "str",
"ui_restrictions": [
"string"
],
"validations": [
{}
],
"value": {}
},
"additionalProperty2": {
"category": "string",
"": 42.0,
"depends_on": [
{}
],
"display": "textbox",
"label": "string",
"options": [
{}
],
"order": 42.0,
"placeholder": "string",
"required": true,
"sensitive": true,
"tooltip": "string",
"type": "str",
"ui_restrictions": [
"string"
],
"validations": [
{}
],
"value": {}
}
},
"custom_scheduling": {
"additionalProperty1": {
"configuration_overrides": {
"max_crawl_depth": 42.0,
"sitemap_discovery_disabled": true,
"domain_allowlist": [
"string"
],
"sitemap_urls": [
"string"
],
"seed_urls": [
"string"
]
},
"enabled": true,
"interval": "string",
"": "string",
"name": "string"
},
"additionalProperty2": {
"configuration_overrides": {
"max_crawl_depth": 42.0,
"sitemap_discovery_disabled": true,
"domain_allowlist": [
"string"
],
"sitemap_urls": [
"string"
],
"seed_urls": [
"string"
]
},
"enabled": true,
"interval": "string",
"": "string",
"name": "string"
}
},
"description": "string",
"error": "string",
"features": {
"document_level_security": {
"enabled": true
},
"incremental_sync": {
"enabled": true
},
"native_connector_api_keys": {
"enabled": true
},
"sync_rules": {
"advanced": {
"enabled": true
},
"basic": {
"enabled": true
}
}
},
"filtering": [
{
"active": {
"advanced_snippet": {},
"rules": [
{}
],
"validation": {}
},
"domain": "string",
"draft": {
"advanced_snippet": {},
"rules": [
{}
],
"validation": {}
}
}
],
"id": "string",
"index_name": "string",
"is_native": true,
"language": "string",
"last_access_control_sync_error": "string",
"": "string",
"last_access_control_sync_status": "canceling",
"last_deleted_document_count": 42.0,
"last_indexed_document_count": 42.0,
"last_sync_error": "string",
"last_sync_status": "canceling",
"name": "string",
"pipeline": {
"extract_binary_content": true,
"name": "string",
"reduce_whitespace": true,
"run_ml_inference": true
},
"scheduling": {
"access_control": {
"enabled": true,
"interval": "string"
},
"full": {
"enabled": true,
"interval": "string"
},
"incremental": {
"enabled": true,
"interval": "string"
}
},
"service_type": "string",
"status": "created",
"sync_cursor": {},
"sync_now": true
}
]
}