MAmacrometa
Connections

Validate a connection

Validate a connection to an external data source.

post/_fabric/{fabric}/_api/connections/validate

Request

Path parameters

fabricstring required

Fabric name of the resource.

Request body

namestring

Name of the connection.

typestring

Connection type.

isEditableboolean

Indicates whether this connection is editable or not.

isInternalboolean

Specifies whether this connection is internal or not.

metadataobject

Contains the metadata of the connection. Configurations for the connector, which are set up through this connection, must be provided as key-value pairs.

Example request

{
  "name": "ToPostgres",
  "type": "dataConnector",
  "connector": {
    "name": "macrometa-source-oracle",
    "displayName": "OracleDB",
    "description": "Source for loading data from a GDN collection.",
    "type": "source",
    "version": "1.0.0"
  },
  "metadata": {
    "host": "127.0.0.1",
    "port": "5432",
    "user": "postgres",
    "password": "abcdef"
  }
}

Response

Successfully validated the connection.

errorboolean required
codeinteger
reasonstring

If invalid, reason for marking resource as invalid.

Example response

{
  "reason": "Incorrect username/password"
}

Changes

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