New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update connector scheduling API Update connector status API »
Elastic Docs ›Elasticsearch Guide [8.13] ›REST APIs ›Connector APIs

Update connector service type API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Update connector service type API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Updates the service_type of a connector.

Request

edit

PUT _connector/<connector_id>/_service_type

Prerequisites

edit
  • To sync data using connectors, it’s essential to have the Elastic connectors service running.
  • 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:

PUT _connector/my-connector/_service_type
{
    "service_type": "sharepoint_online"
}
Copy as curlTry in Elastic 
{
    "result": "updated"
}
« Update connector scheduling API Update connector status API »

On this page

Was this helpful?
Feedback