Update the connector status Technical preview; Added in 8.12.0

PUT /_connector/{connector_id}/_status
Api key auth Basic auth Bearer auth

Path parameters

  • connector_id string Required

    The unique identifier of the connector to be updated

application/json

Body Required

  • status string Required

    Values are created, needs_configuration, configured, connected, or error.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • result string Required

      Values are created, updated, deleted, not_found, or noop.
PUT /_connector/{connector_id}/_status 
PUT _connector/my-connector/_status { "status": "needs_configuration" }
resp = client.connector.update_status( connector_id="my-connector", status="needs_configuration", )
const response = await client.connector.updateStatus({ connector_id: "my-connector", status: "needs_configuration", });
response = client.connector.update_status( connector_id: "my-connector", body: { "status": "needs_configuration" } )
$resp = $client->connector()->updateStatus([ "connector_id" => "my-connector", "body" => [ "status" => "needs_configuration", ], ]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"status":"needs_configuration"}' "$ELASTICSEARCH_URL/_connector/my-connector/_status"
client.connector().updateStatus(u -> u .connectorId("my-connector") .status(ConnectorStatus.NeedsConfiguration) );
Request example 
{ "status": "needs_configuration" }
Response examples (200) 
{ "result": "updated" }