Update connector status 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 status of a connector.
Requestedit
PUT _connector/<connector_id>/_status
Prerequisitesedit
- To sync data using connectors, it’s essential to have the Elastic connectors service running.
-
The
connector_idparameter should reference an existing connector. -
The change of
statusmust be a valid status transition according to the Connector Protocol.
Path parametersedit
-
<connector_id> - (Required, string)
Request bodyedit
-
status - (Required, string) A valid connector status string, defined in the Connector Framework.
Response codesedit
-
200 -
Connector
statusfield was successfully updated. -
400 -
The
connector_idwas not provided, the request payload was malformed, or the given status transition is not supported. -
404(Missing resources) -
No connector matching
connector_idcould be found.
Examplesedit
The following example updates the status of the connector with ID my-connector:
PUT _connector/my-connector/_status
{
"status": "needs_configuration"
}
{
"result": "updated"
}