Skip to content

Create and Manage a Connection

A connection is a saved configuration that lets PlaidCloud reach an external system — a database, data lake, ERP, REST API, cloud service, or Git provider. Workflow steps reference the connection by name, so endpoint details and credentials live in one place and are reused across every step and project that needs them.

Connections are managed from Tools > Connections.

  1. Open Tools > Connections
  2. Click New Connection in the toolbar and choose the system you want to connect to from the menu
  3. Fill in the connection form (the tabs and fields vary by type — see Connection Form below)
  4. Click Create to save

The new connection appears in the list, owned by you.

Acumatica, Bill.com, Dynamics, Eclipse, HFM/FCCS, NetSuite, Workday and Workday Financials connections are saved as REST connections, and the Type column in the list shows the service’s own type. Each opens in its own form for creating, editing and picking in steps. Headers, authentication and pagination are in Edit REST settings, which you reach from the right-click menu (see Edit a Connection).

Most connections open a multi-tab form. The exact tabs depend on the type, but you’ll commonly see:

  • Connection Config (or Connection Details for REST) — the connection Name, an optional Memo, the host/port/database (or host/auth type for REST), the Usage toggle (Active), and the Security Model. On a database connection the credentials sit here in an Auth Credentials group; on a REST connection they get their own Authentication tab.
  • SSL Config — Use SSL plus the SSL mode and optional client/root certificates for an encrypted connection.
  • SSH Config — Use SSH plus the bastion host, port, user, and key to tunnel the connection through an SSH jump host.

Password, token, and other credential fields are write-only: they show blank when you reopen a saved connection, and leaving them blank on save keeps the stored secret. Retype a value only when you want to change it. This covers a REST connection’s API key, OAuth client secret, and OAuth refresh token. Multi-line credentials — a NetSuite private certificate, an Anaplan certificate and private key, a Postman API key, a Slack or Teams incoming-webhook URL — are write-only the same way and are masked as you type or paste them. A replacement made only of spaces is refused rather than saved over the stored credential; clear the field to keep the saved value. A SQL or Git connection’s SSL client key and SSH private key are write-only too, but stay visible while you’re typing them. Every other field shows its real saved value everywhere the connection is shown, in the editor and over the API, including fields that look sensitive by name (a database’s read-only flag, an account identifier, a schema, a host name) — only an actual credential is ever masked or hidden.

Over the REST API and MCP, a credential field follows the same rule as the editor: send an empty string and PlaidCloud keeps the stored value; send null to clear it. Every non-credential field still clears when you send it blank.

Required fields are validated on save; if something is missing, the form switches to the tab holding the first invalid field and flags it.

The Security Model on a connection controls who in the workspace can use it:

Option Who can use the connection
Private (Only Owners) Just the owners.
Specific Members Only Owners plus an explicit list of members.
Specific Security Groups Only Owners plus members of named security groups.
All Workspace Members Everyone in the workspace.

When you choose Specific Members Only or Specific Security Groups Only, grant the access from the list’s Actions menu — Members for Specific Members Only or Groups for Specific Security Groups Only, plus Agents and Owners, each open a filterable checklist where you tick who has access (see Assigning With the Picker). Only an owner of the connection, or a workspace admin, can change access there. Anyone else who can edit connections can open them to see who has access, in a read-only list of the people already assigned. A workspace admin can change access on a connection they don’t own, to hand it on when its owners have left.

Anyone who can use a connection can open it and see its settings, and browse a Git connection’s repositories, branches, and files. A connection’s passwords, tokens, and keys are returned only to members who can edit connections or workflows. Through the REST API and MCP, everyone else gets them masked.

When you browse a Git connection with a different server URL than the saved one, enter a token for that server.

A connection can hold a different configuration per environment (for example a development host and a production host under one connection name). The environment selector in the toolbar chooses which environment’s configuration you are viewing and editing.

  • New Environment — add a connection environment
  • Edit Environment — rename the selected environment
  • Delete Environment — remove the selected environment, once no project uses it, no step has it as a fixed environment and no agent serves it. Otherwise the message says what still uses it. The default environment can’t be deleted.

The Available column in the list shows whether the selected connection is configured for the chosen environment.

Environments are shared with PlaidLink agents, so a project’s environment can switch the agent that runs its remote steps as well as the connections it reads. See Agent Environments.

  1. Select the connection in the list
  2. Click Edit in the toolbar (or right-click the row)
  3. Change the fields and click Update

For an Acumatica, Bill.com, Dynamics, Eclipse, HFM/FCCS, NetSuite, Workday or Workday Financials connection, Edit opens that service’s own form. To change the headers, authentication or pagination of the underlying REST connection, right-click the connection and choose Edit REST settings.

How you test depends on the type:

  • Database connections — Databricks, Snowflake, PostgreSQL, and Redshift — have a Test Connection button in the editor. It opens the connection with the credentials you entered and reports success (with the server version it reached) or the reason it failed, without closing the editor, so you can fix and retry in place.
  • Database connections with SSH also expose a test for the SSH tunnel in the SSH Config tab.
  • The Generic REST Connection has a Testing tab that fires an ad-hoc request through the saved connection.

Save the connection before testing — tests run against the stored configuration.

A connection can’t point at a loopback, link-local or cloud metadata address. PlaidCloud checks the address a host name resolves to when you test the connection and when a step uses it, and an address that doesn’t qualify fails with an error naming the host and the address it resolved to. Addresses on your private network aren’t affected.

  • Clone — duplicate a connection’s configuration as the basis for a new one. See Clone a Connection.
  • Delete — remove the selected connection from the toolbar (you are asked to confirm).
  • Where Used… — list the workflow steps that reference the connection, so you can see the impact before editing or deleting it.

The same applies through the REST API, JSON-RPC and the AI assistant or MCP: changing a connection’s settings needs you to be one of its owners, or a workspace administrator for a connection with no owner. Enabling, disabling, locking and unlocking a connection need an owner or a workspace administrator. A request naming several connections applies only when you can change every one of them.