Skip to content
PlaidCloud

Generic REST Connection

The generic REST connection connects PlaidCloud to any HTTP/REST service that doesn’t have a dedicated connector. It supports the common authentication patterns (None, Basic, API Key, Bearer token, OAuth 2.0), default request headers, fine-grained redirect and transport handling, and an in-form request tester.

Configuration

Section titled “Configuration”

The form has four tabs.

Connection Details

Section titled “Connection Details”
Field Type Description
Connection Name Text Display name for this connection.
Memo Text (multi-line) Optional notes about the connection.
Host or IP Address Text Base host the requests target.
Active (Allow Access) Toggle Whether the connection is enabled. Disable to pause without deleting.
Authentication Type Select None, Basic, API Key, Bearer Token, or OAuth 2.0. Selecting a type enables the matching group on the Authentication tab.
Security Model Select Who can use the connection — Private, Specific Members, Specific Security Groups, or All Workspace Members.

Connection Settings

Section titled “Connection Settings”
Setting Default Description
Enable SSL certificate verification Off Verify SSL certificates when sending a request. Verification failures abort the request.
Automatically follow redirects On Follow HTTP 3xx responses as redirects.
Follow original HTTP Method Off Redirect with the original HTTP method instead of the default of redirecting with GET.
Follow Authorization Header Off Retain the authorization header when a redirect happens.
Remove referer header on redirect Off Remove the referer header when a redirect happens.
Enabled strict HTTP parser Off Reject responses with invalid HTTP headers.
Encode URL automatically On Encode the URL’s path, query parameters, and authentication fields.
Disable cookie jar Off Don’t store this request’s cookies in the cookie jar, and don’t send stored cookies as headers.
Use server cipher suite during handshake Off Use the server’s cipher suite order instead of the client’s during the handshake.
Maximum number of redirects 10 Cap on the number of redirects to follow.

Authentication

Section titled “Authentication”

Only the group matching the selected Authentication Type is shown. With None, the tab is disabled.

Basic

Field Type Description
User Text Basic-auth username.
Password Password Basic-auth password (write-only).

API Key

Field Type Description
Key Text API key field name.
Value Text API key value.

Bearer Token

Field Type Description
Token Password Bearer token (write-only).

OAuth 2.0

Field Type Description
Add auth data to Select Send the auth data in the Request Headers or the Request URL.
Header Prefix Text Prefix for the authorization header value (defaults to Bearer).
Auth URL Text Authorization endpoint.
Access Token URL Text Token endpoint.
Client ID Text OAuth client identifier.
Client Secret Text OAuth client secret.
Refresh Token URL Text Endpoint used to refresh the token.
Initial Refresh Token Text Seed refresh token for the first exchange.
Additional Token Request Parameters Table Extra body parameters sent on token requests (Enabled, Name, Value, Description).
Additional Token Request Headers Table Extra headers sent on token requests (Enabled, Name, Value, Description).

Default Headers

Section titled “Default Headers”

A table of headers sent on every request through this connection. Each row has Enabled, Header Name, Value, and Description. Use the row buttons to add, insert, and delete headers.

Testing

Section titled “Testing”

Fire an ad-hoc request through the saved connection to confirm it works.

Field Type Description
Testing Endpoint Text Full URL to call (for example https://example.com/rest/test/validate).
Method Select GET, PUT, POST, DELETE, HEAD, or OPTIONS.
Payload Code Request body. Supports Django/Jinja-style template tokens.
Send Test Request Button Sends the request and shows the response (or the error).
Section titled “Related”