You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get connector APIedit
This 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.
Retrieves the details about a connector.
To get started with Connector APIs, check out the tutorial.
Requestedit
GET _connector/<connector_id>
Prerequisitesedit
- 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.
Path parametersedit
-
<connector_id>
- (Required, string)
Response codesedit
-
400
-
The
connector_id
was not provided. -
404
(Missing resources) -
No connector matching
connector_id
could be found.
Examplesedit
The following example gets the connector my-connector
:
response = client.connector.get( connector_id: 'my-connector' ) puts response
GET _connector/my-connector