This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Update connector scheduling API Create connector sync job API »
Elastic Docs ›Elasticsearch Guide [8.16] ›REST APIs ›Connector APIs

Update connector service type API

edit

Update connector service type API

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Updates the service_type of a connector.

To get started with Connector APIs, check out our tutorial.

Request

edit

PUT _connector/<connector_id>/_service_type

Prerequisites

edit
  • To sync data using self-managed connectors, you need to deploy the Elastic connector service. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
  • The connector_id parameter should reference an existing connector.

  • The service_type must be a valid type as defined by the Connector framework.

    • When you change a configured connector’s service_type, you’ll also need to reset its configuration to ensure compatibility.

Path parameters

edit
<connector_id>
(Required, string)

Request body

edit
service_type
(Required, string) A connector service type defined in the Connector framework.

Response codes

edit
200
Connector service_type field was successfully updated.
400
The connector_id was not provided or the request payload was malformed.
404 (Missing resources)
No connector matching connector_id could be found.

Examples

edit

The following example updates the service_type of the connector with ID my-connector:

resp = client.connector.update_service_type(
    connector_id="my-connector",
    service_type="sharepoint_online",
)
print(resp)
response = client.connector.update_service_type(
  connector_id: 'my-connector',
  body: {
    service_type: 'sharepoint_online'
  }
)
puts response
const response = await client.connector.updateServiceType({
  connector_id: "my-connector",
  service_type: "sharepoint_online",
});
console.log(response);
PUT _connector/my-connector/_service_type
{
    "service_type": "sharepoint_online"
}
{
    "result": "updated"
}
« Update connector scheduling API Create connector sync job API »