Update the connector configuration Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_configuration

Update the configuration field in the connector document.

Path parameters

  • connector_id string Required

    The unique identifier of the connector to be updated

application/json

Body Required

Responses

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

      Values are created, updated, deleted, not_found, or noop.
PUT /_connector/{connector_id}/_configuration 
PUT _connector/my-connector-id/_configuration
{
  "values": {
    "host": "127.0.0.1",
    "port": 5432,
    "username": "myuser",
    "password": "mypassword",
    "database": "chinook",
    "schema": "public",
    "tables": "album,artist"
  }
}
curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_configuration' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"values\": {\n    \"host\": \"127.0.0.1\",\n    \"port\": 5432,\n    \"username\": \"myuser\",\n    \"password\": \"mypassword\",\n    \"database\": \"chinook\",\n    \"schema\": \"public\",\n    \"tables\": \"album,artist\"\n  }\n}"'
Request examples
An example body for a `PUT _connector/my-connector-id/_configuration` request. 
{
  "values": {
    "host": "127.0.0.1",
    "port": 5432,
    "username": "myuser",
    "password": "mypassword",
    "database": "chinook",
    "schema": "public",
    "tables": "album,artist"
  }
}
{
    "values": {
        "tenant_id": "my-tenant-id",
        "tenant_name": "my-sharepoint-site",
        "client_id": "foo",
        "secret_value": "bar",
        "site_collections": "*"
    }
}
{
    "values": {
        "secret_value": "foo-bar"
    }
}
Response examples (200) 
{
  "result": "updated"
}

Documentation preview

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

View current documentation