proxy_agent_connections
Creates, updates, deletes, gets or lists a proxy_agent_connections resource.
Overview
| Name | proxy_agent_connections |
| Type | Resource |
| Id | fivetran.networking.proxy_agent_connections |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
connection_id | string | The unique identifier for the connection within the Fivetran system. (example: connection_id) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | agent_id | cursor, limit | Returns all connections attached to the specified proxy agent within your Fivetran account. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
agent_id | string | The unique identifier for the proxy agent within the Fivetran system. |
cursor | string | Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination) |
limit | integer (int32) | Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100. |
SELECT examples
- list
Returns all connections attached to the specified proxy agent within your Fivetran account.
SELECT
connection_id
FROM fivetran.networking.proxy_agent_connections
WHERE agent_id = '{{ agent_id }}' -- required
AND "limit" = '{{ limit }}'
;