You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Update connector service type APIedit
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.
Requestedit
PUT _connector/<connector_id>/_service_type
Prerequisitesedit
- 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 native connectors.
-
The
connector_idparameter should reference an existing connector. -
The
service_typemust 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_typefield was successfully updated. -
400 -
The
connector_idwas not provided or the request payload was malformed. -
404(Missing resources) -
No connector matching
connector_idcould be found.
Examplesedit
The following example updates the service_type of the connector with ID my-connector:
response = client.connector.update_service_type(
connector_id: 'my-connector',
body: {
service_type: 'sharepoint_online'
}
)
puts response
PUT _connector/my-connector/_service_type
{
"service_type": "sharepoint_online"
}
{
"result": "updated"
}