Check in connector API
editCheck in connector 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 last_seen
field of a connector with current timestamp.
To get started with Connector APIs, check out the tutorial.
Request
editPUT _connector/<connector_id>/_check_in
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.
Path parameters
edit-
<connector_id>
- (Required, string)
Response codes
edit-
200
-
Connector
last_seen
field was successfully updated with a current timestamp. -
400
-
The
connector_id
was not provided. -
404
(Missing resources) -
No connector matching
connector_id
could be found.
Examples
editThe following example updates the last_seen
property with current timestamp for the connector with ID my-connector
:
resp = client.connector.check_in( connector_id="my-connector", ) print(resp)
response = client.connector.check_in( connector_id: 'my-connector' ) puts response
const response = await client.connector.checkIn({ connector_id: "my-connector", }); console.log(response);
PUT _connector/my-connector/_check_in
{ "result": "updated" }