Create or update a connector

PUT /_connector/{connector_id}
PUT /_connector

Authentication

Authorization: <value>

Elasticsearch APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Path parameters

Request body

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.put({
  connector_id: "my-connector",
  index_name: "search-google-drive",
  name: "My Connector",
  service_type: "google_drive",
});

Python Elasticsearch Python Client

resp = client.connector.put(
    connector_id="my-connector",
    index_name="search-google-drive",
    name="My Connector",
    service_type="google_drive",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index_name": "search-google-drive",
    "name": "My Connector",
    "service_type": "google_drive"
  }'

Java Elasticsearch Java Client

client.connector().put(p -> p
    .connectorId("my-connector")
    .indexName("search-google-drive")
    .name("My Connector")
    .serviceType("google_drive")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->put([
    "connector_id" => "my-connector",
    "body" => [
        "index_name" => "search-google-drive",
        "name" => "My Connector",
        "service_type" => "google_drive",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.put(
  connector_id: "my-connector",
  body: {
    "index_name": "search-google-drive",
    "name": "My Connector",
    "service_type": "google_drive"
  }
)

Response

{
  "result": "created",
  "id": "my-connector"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /_connector
{
  "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"
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
  }'

Generated from the API spec

Response

{
  "result": "created",
  "id": "my-connector"
}

Authentication

Path parameters

Request body { }

Response

Request body