MAmacrometa
Connections

Update connection details

Update a connection. Note that if the connection is already in use, then it will not be updated in the workflows.

put/_fabric/{fabric}/_api/connections/{connection-name}

Request

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 updated the connection.

errorboolean required
codeinteger

Example response

{
  "result": {
    "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"
    }
  }
}

Changes

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