Connections

Get connector details

Obtain comprehensive information about the connector, including the configuration details necessary for setting up an connection using this connector.

get/_api/connectors/{connector-name}

Request

Path parameters

connector-namestring required

Name of the connector.

Query parameters

type'source' | 'target'

Specifies which type of connector to retrieve, No value returns both source and target connectors.

Response

Succesfully fetched the connector.

errorboolean required
codeinteger

Example response

{
  "result": [
    {
      "name": "macrometa-source-oracle",
      "displayName": "OracleDB",
      "description": "Source for loading data from a GDN collection.",
      "type": "source",
      "version": "1.0.0"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.