Create or update a connector Beta; Added in 8.12.0

PUT /_connector/{connector_id}
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

PUT /_connector

PUT /_connector/{connector_id}

Path parameters

  • connector_id string Required

    The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.

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/{connector_id} 
PUT _connector/my-connector { "index_name": "search-google-drive", "name": "My Connector", "service_type": "google_drive" }
resp = client.connector.put( connector_id="my-connector", index_name="search-google-drive", name="My Connector", service_type="google_drive", )
const response = await client.connector.put({ connector_id: "my-connector", index_name: "search-google-drive", name: "My Connector", service_type: "google_drive", });
response = client.connector.put( connector_id: "my-connector", body: { "index_name": "search-google-drive", "name": "My Connector", "service_type": "google_drive" } )
$resp = $client->connector()->put([ "connector_id" => "my-connector", "body" => [ "index_name" => "search-google-drive", "name" => "My Connector", "service_type" => "google_drive", ], ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"index_name":"search-google-drive","name":"My Connector","service_type":"google_drive"}' "$ELASTICSEARCH_URL/_connector/my-connector"
client.connector().put(p -> p .connectorId("my-connector") .indexName("search-google-drive") .name("My Connector") .serviceType("google_drive") );
Request examples 
{ "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" }