MAmacrometa
Connections

Retrieve schema from the data source

Retrieve schema for the connector by supplying the connector configurations.

post/_api/connectors/{connector-name}/schema

Request

Path parameters

connector-namestring required

Name of the connector.

Request body

typestring

Connector type. source or target.

configobject

Contains the connector configurations. Key-value pairs should be provided to configure the connection to the respective data source or target.

Example request

{
  "type": "source",
  "config": {
    "host": "db.postgres.com",
    "port": 5432,
    "username": "postgres",
    "password": "password"
  }
}

Response

Successfully retrieved connector schema.

errorboolean required
codeinteger

Example response

{
  "result": [
    {
      "attributes": [
        {
          "name": "Name",
          "type": "string"
        }
      ]
    }
  ]
}

Changes

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