AVEVA PI API Configuration Sunset

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "aveva_pi",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "always_encrypted": true,
    "connection_type": "Directly | PrivateLink",
    "database": "my_db",
    "host": "127.0.0.1",
    "password": "string",
    "port": 443,
    "tunnel_host": "string",
    "tunnel_port": 0,
    "tunnel_user": "string",
    "user": "myuser",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`always_encrypted`	Require TLS.
`connection_type`	Possible values: `Directly`, `PrivateLink`
`database`
`host`	IP address of the AF Server
`password`
`port`	Port number at which the AF Server is running
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`user`	Username for the user to authenticate as with the AF Server
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the user and password parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "aveva_pi",
  "group_id": "group_id",
  "config": {
    "user": "myuser",
    "password": "string"
  }
}

By using the Connect Card or the Fivetran dashboard.