Connections

Create a connection

Create a connection using a connector to an external data source.

post/_fabric/{fabric}/_api/connections

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/connections/post.ts
A function with typed inputs. Its response is checked against the schema.

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 created 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.