Skip to main content
POST
/
import
/
forms
/
sources
Create import source form
curl --request POST \
  --url https://api.prequel.co/import/forms/sources \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source": {
    "vendor": "<unknown>",
    "postgres": {
      "host": "<string>",
      "port": 5432,
      "database": "<string>",
      "auth_method": "password_auth",
      "password_auth": {
        "username": "<string>",
        "password": "<string>"
      },
      "use_ssh_tunnel": true,
      "disable_ssl": true
    },
    "provider_id": "<string>",
    "name": "<string>"
  }
}
'
{
  "status": "<string>",
  "data": {
    "fields": [
      {
        "path": "<string>",
        "name": "<string>",
        "type": "<string>",
        "required": true,
        "refetch_on_change": true,
        "attributes": {
          "label": "<string>",
          "form_element": "<string>",
          "description": "<string>",
          "placeholder": "<string>",
          "input_type": "<string>",
          "key_format": "<string>"
        },
        "parent": "<unknown>",
        "read_only": true,
        "const": "<unknown>",
        "default": "<unknown>",
        "enum": [
          {
            "key": "<unknown>",
            "display": "<string>",
            "icon_url": "<string>",
            "disabled": true
          }
        ]
      }
    ]
  },
  "message": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
source
PostgreSQL · object
required

Response

OK

status
string
required
Allowed value: "success"
data
object
required
message
string
required