Type to search.

Get a connector

Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Beta This functionality is in beta and is not ready for production usage. For beta features, the design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Get the details about a connector.

Path parameters

connector_id string required

The unique identifier of the connector

Query parameters

include_deleted boolean · default: false

A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

Response

application/json
api_key_id string
api_key_secret_id string
configuration object required
custom_scheduling object required
deleted boolean required
description string
error union string nullable
One of: string
filtering object[] required
active object required
advanced_snippet object required
created_at union oneOf
One of: string or number
updated_at union oneOf
One of: string or number
value object required
rules object[] required
created_at union oneOf
One of: string or number
field string required
id string required
order number required
policy enum required
Values: exclude include
rule enum required
Values: contains ends_with equals regex starts_with > <
updated_at union oneOf
One of: string or number
value string required
validation object required
errors object[] required
ids string[] required
messages string[] required
state enum required
Values: edited invalid valid
domain string
draft object required
Same fields as active in filtering
id string
index_name union string nullable
is_native boolean required
language string
last_access_control_sync_error string
last_access_control_sync_scheduled_at union oneOf
One of: string or number
last_access_control_sync_status enum
Values: canceling canceled completed error in_progress pending suspended
last_deleted_document_count number
last_incremental_sync_scheduled_at union oneOf
One of: string or number
last_indexed_document_count number
last_seen union oneOf
One of: string or number
last_sync_error string
last_sync_scheduled_at union oneOf
One of: string or number
last_sync_status enum
Values: canceling canceled completed error in_progress pending suspended
last_synced union oneOf
One of: string or number
name string
scheduling object required
service_type string
status enum required
Values: created needs_configuration configured connected error
sync_cursor object
sync_now boolean required