Create or update a connector Beta; Added in 8.12.0

PUT /_connector
application/json

Body

  • description string
  • index_name string
  • is_native boolean
  • language string
  • name string
  • service_type string

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • result string Required

      Values are created, updated, deleted, not_found, or noop.

    • id string Required
PUT /_connector 
PUT _connector/my-{service-name-stub}-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from {service-name}",
  "service_type": "{service-name-stub}",
  "is_native": true
}
curl \
 --request PUT 'http://api.example.com/_connector' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index_name\": \"my-elasticsearch-index\",\n  \"name\": \"Content synced from {service-name}\",\n  \"service_type\": \"{service-name-stub}\",\n  \"is_native\": true\n}"'
Request examples
An example body for a `PUT _connector/my-{service-name-stub}-connector` request. 
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from {service-name}",
  "service_type": "{service-name-stub}",
  "is_native": true
}
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "description": "My Connector to sync data to Elastic index from Google Drive",
  "service_type": "google_drive",
  "language": "english"
}
Response examples (200) 
{
  "result": "created",
  "id": "my-connector"
}

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation