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 status API
editUpdate connector status API
editThis 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.
To get started with Connector APIs, check out our tutorial.
Request
editPUT _connector/<connector_id>/_status
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 change of
status
must be a valid status transition according to the Connector Protocol.
Path parameters
edit-
<connector_id>
- (Required, string)
Request body
edit-
status
- (Required, string) A valid connector status string, defined in the Connector Framework.
Response codes
edit-
200
-
Connector
status
field was successfully updated. -
400
-
The
connector_id
was not provided, the request payload was malformed, or the given status transition is not supported. -
404
(Missing resources) -
No connector matching
connector_id
could be found.
Examples
editThe following example updates the status
of the connector with ID my-connector
:
resp = client.connector.update_status( connector_id="my-connector", status="needs_configuration", ) print(resp)
response = client.connector.update_status( connector_id: 'my-connector', body: { status: 'needs_configuration' } ) puts response
const response = await client.connector.updateStatus({ connector_id: "my-connector", status: "needs_configuration", }); console.log(response);
PUT _connector/my-connector/_status { "status": "needs_configuration" }
{ "result": "updated" }