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 service type API
editUpdate connector service type APIedit
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.
Requestedit
PUT _connector/<connector_id>/_service_type
Prerequisitesedit
- 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.
-
When you change a configured connector’s
Path parametersedit
-
<connector_id>
- (Required, string)
Request bodyedit
-
service_type
- (Required, string) A connector service type defined in the Connector framework.
Response codesedit
-
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.
Examplesedit
The following example updates the service_type
of the connector with ID my-connector
:
PUT _connector/my-connector/_service_type { "service_type": "sharepoint_online" }
{ "result": "updated" }