Update the connector API key ID

PUT /_connector/{connector_id}/_api_key_id

Auth

Update the api_key_id and api_key_secret_id fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

Path parameters

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

Request body

api_key_id string
api_key_secret_id string

Response

application/json

result enum required: Values: created updated deleted not_found noop

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

PUT _connector/my-connector/_api_key_id
{
    "api_key_id": "my-api-key-id",
    "api_key_secret_id": "my-connector-secret-id"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.connector.updateApiKeyId({
  connector_id: "my-connector",
  api_key_id: "my-api-key-id",
  api_key_secret_id: "my-connector-secret-id",
});

Python Elasticsearch Python Client

resp = client.connector.update_api_key_id(
    connector_id="my-connector",
    api_key_id="my-api-key-id",
    api_key_secret_id="my-connector-secret-id",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_connector/my-connector/_api_key_id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key_id": "my-api-key-id",
    "api_key_secret_id": "my-connector-secret-id"
  }'

Java Elasticsearch Java Client

client.connector().updateApiKeyId(u -> u
    .apiKeyId("my-api-key-id")
    .apiKeySecretId("my-connector-secret-id")
    .connectorId("my-connector")
);

PHP Elasticsearch PHP Client

$resp = $client->connector()->updateApiKeyId([
    "connector_id" => "my-connector",
    "body" => [
        "api_key_id" => "my-api-key-id",
        "api_key_secret_id" => "my-connector-secret-id",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.connector.update_api_key_id(
  connector_id: "my-connector",
  body: {
    "api_key_id": "my-api-key-id",
    "api_key_secret_id": "my-connector-secret-id"
  }
)

Response

{
  "result": "updated"
}

Path parameters

Request body { }

Response

Request body