Update the connector configuration

PUT /_connector/{connector_id}/_configuration

Auth

Update the configuration field in the connector document.

Path parameters

connector_id string required: The unique identifier of the connector to be updated

Request body

configuration object
values map string to object

Response

application/json

result enum required: Values: created updated deleted not_found noop

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-spo-connector/_configuration
{
    "values": {
        "tenant_id": "my-tenant-id",
        "tenant_name": "my-sharepoint-site",
        "client_id": "foo",
        "secret_value": "bar",
        "site_collections": "*"
    }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
    tenant_id: "my-tenant-id",
    tenant_name: "my-sharepoint-site",
    client_id: "foo",
    secret_value: "bar",
    site_collections: "*",
  },
});

Python Elasticsearch Python Client

resp = client.connector.update_configuration(
    connector_id="my-spo-connector",
    values={
        "tenant_id": "my-tenant-id",
        "tenant_name": "my-sharepoint-site",
        "client_id": "foo",
        "secret_value": "bar",
        "site_collections": "*"
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-spo-connector/_configuration" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "values": {
      "tenant_id": "my-tenant-id",
      "tenant_name": "my-sharepoint-site",
      "client_id": "foo",
      "secret_value": "bar",
      "site_collections": "*"
    }
  }'

Java Elasticsearch Java Client

client.connector().updateConfiguration(u -> u
    .connectorId("my-spo-connector")
    .values(Map.of("tenant_id", JsonData.fromJson("\"my-tenant-id\""),"tenant_name", JsonData.fromJson("\"my-sharepoint-site\""),"secret_value", JsonData.fromJson("\"bar\""),"client_id", JsonData.fromJson("\"foo\""),"site_collections", JsonData.fromJson("\"*\"")))
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateConfiguration([
    "connector_id" => "my-spo-connector",
    "body" => [
        "values" => [
            "tenant_id" => "my-tenant-id",
            "tenant_name" => "my-sharepoint-site",
            "client_id" => "foo",
            "secret_value" => "bar",
            "site_collections" => "*",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_configuration(
  connector_id: "my-spo-connector",
  body: {
    "values": {
      "tenant_id": "my-tenant-id",
      "tenant_name": "my-sharepoint-site",
      "client_id": "foo",
      "secret_value": "bar",
      "site_collections": "*"
    }
  }
)

Response

{
  "result": "updated"
}

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-spo-connector/_configuration
{
    "values": {
        "secret_value": "foo-bar"
    }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
    secret_value: "foo-bar",
  },
});

Python Elasticsearch Python Client

resp = client.connector.update_configuration(
    connector_id="my-spo-connector",
    values={
        "secret_value": "foo-bar"
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-spo-connector/_configuration" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "values": {
      "secret_value": "foo-bar"
    }
  }'

Java Elasticsearch Java Client

client.connector().updateConfiguration(u -> u
    .connectorId("my-spo-connector")
    .values("secret_value", JsonData.fromJson("\"foo-bar\""))
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateConfiguration([
    "connector_id" => "my-spo-connector",
    "body" => [
        "values" => [
            "secret_value" => "foo-bar",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_configuration(
  connector_id: "my-spo-connector",
  body: {
    "values": {
      "secret_value": "foo-bar"
    }
  }
)

Response

{
  "result": "updated"
}

Path parameters

Request body { }

Response

Request body