Update the connector status

PUT /_connector/{connector_id}/_status

Auth

Path parameters

connector_id string required: The unique identifier of the connector to be updated

Request body

status enum required: Values: created needs_configuration configured connected error

Response

application/json

result enum required: Values: created updated deleted not_found noop

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-connector/_status
{
    "status": "needs_configuration"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateStatus({
  connector_id: "my-connector",
  status: "needs_configuration",
});

Python Elasticsearch Python Client

resp = client.connector.update_status(
    connector_id="my-connector",
    status="needs_configuration",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector/_status" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "needs_configuration"
  }'

Java Elasticsearch Java Client

client.connector().updateStatus(u -> u
    .connectorId("my-connector")
    .status(ConnectorStatus.NeedsConfiguration)
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateStatus([
    "connector_id" => "my-connector",
    "body" => [
        "status" => "needs_configuration",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_status(
  connector_id: "my-connector",
  body: {
    "status": "needs_configuration"
  }
)

Response

{
  "result": "updated"
}

Path parameters

Request body { }

Response

Request body