Update connector API key ID API
editUpdate connector API key ID API
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Updates the api_key_id
and/or api_key_secret_id
field(s) of a connector, specifying:
- The ID of the API key used for authorization
- The ID of the Connector Secret where the API key is stored
The Connector Secret ID is only required for native connectors. Connector clients do not use this field. See the documentation for managing native connector API keys programmatically for more details.
To get started with Connector APIs, check out the tutorial.
Request
editPUT _connector/<connector_id>/_api_key_id
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 native connectors.
-
The
connector_id
parameter should reference an existing connector. -
The
api_key_id
parameter should reference an existing API key. -
The
api_key_secret_id
parameter should reference an existing Connector Secret containing an encoded API key value.
Path parameters
edit-
<connector_id>
- (Required, string)
Request body
edit-
api_key_id
- (Optional, string) ID of the API key that the connector will use to authorize access to required indices. Each connector can be associated with at most one API key.
-
api_key_secret_id
-
(Optional, string) ID of the Connector Secret that contains the encoded API key. This should be the same API key as
api_key_id
references. This is only required for native connectors.
Response codes
edit-
200
-
Connector
api_key_id
and/orapi_key_secret_id
field(s) successfully updated. -
400
-
The
connector_id
was not provided or the request payload was malformed. -
404
(Missing resources) -
No connector matching
connector_id
could be found.
Examples
editThe following example updates the api_key_id
and api_key_secret_id
field(s) for the connector with ID my-connector
:
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", ) print(resp)
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' } ) puts response
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", }); console.log(response);
PUT _connector/my-connector/_api_key_id { "api_key_id": "my-api-key-id", "api_key_secret_id": "my-connector-secret-id" }
{ "result": "updated" }